Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Enumerations
basic::citation_manager Namespace Reference

Classes

class  AuthorNames
 Data structure for author names. More...
 
class  Citation
 Data structure for storing a citation. More...
 
class  CitationCollection
 A class for keeping track of a collection of citations for a particular Rosetta module. More...
 
class  CitationCollectionBase
 Base structure for storing a citation. This is a base class for vitual inheritance. There's not much it actually does itself. Its main purpose is to allow us to put both CitationCollections and UnpublishedModuleInfos into the same list. More...
 
class  CitationCollectionList
 A collection of CitationCollectionBases. More...
 
class  CitationManager
 A class that receives lists of works to cite from Rosetta modules, then returns a list of all works to cite on demand. Threadsafe. More...
 
class  UnpublishedModuleAuthor
 Authorship information for a single author in an unpublished Rosetta module. More...
 
class  UnpublishedModuleInfo
 Authorship information for an unpublished Rosetta module. More...
 

Typedefs

typedef
utility::pointer::shared_ptr
< AuthorNames
AuthorNamesOP
 
typedef
utility::pointer::shared_ptr
< AuthorNames const > 
AuthorNamesCOP
 
typedef
utility::pointer::shared_ptr
< Citation
CitationOP
 
typedef
utility::pointer::shared_ptr
< Citation const > 
CitationCOP
 
typedef
utility::pointer::shared_ptr
< CitationCollection
CitationCollectionOP
 
typedef
utility::pointer::shared_ptr
< CitationCollection const > 
CitationCollectionCOP
 
typedef
utility::pointer::shared_ptr
< CitationCollectionBase
CitationCollectionBaseOP
 
typedef
utility::pointer::shared_ptr
< CitationCollectionBase const > 
CitationCollectionBaseCOP
 
typedef
utility::pointer::shared_ptr
< CitationCollectionList
CitationCollectionListOP
 
typedef
utility::pointer::shared_ptr
< CitationCollectionList const > 
CitationCollectionListCOP
 
using CitationManagerOP = utility::pointer::shared_ptr< CitationManager >
 
using CitationManagerCOP = utility::pointer::shared_ptr< CitationManager const >
 
using UnpublishedModuleAuthorOP = utility::pointer::shared_ptr< UnpublishedModuleAuthor >
 
using UnpublishedModuleAuthorCOP = utility::pointer::shared_ptr< UnpublishedModuleAuthor const >
 
using UnpublishedModuleInfoOP = utility::pointer::shared_ptr< UnpublishedModuleInfo >
 
using UnpublishedModuleInfoCOP = utility::pointer::shared_ptr< UnpublishedModuleInfo const >
 

Enumerations

enum  CitationFormat { CitationFormat::DefaultStyle = 1, CitationFormat::NatureStyle, CitationFormat::end_of_list = NatureStyle }
 The format for writing a citation. More...
 
enum  CitedModuleType {
  CitedModuleType::Mover = 1, CitedModuleType::Filter, CitedModuleType::ScoreTerm, CitedModuleType::ResidueSelector,
  CitedModuleType::TaskOperation, CitedModuleType::PackerPalette, CitedModuleType::ScoreFunction, CitedModuleType::EnergyMethod,
  CitedModuleType::SimpleMetric, CitedModuleType::ConstraintGenerator, CitedModuleType::NeuralNetwork, CitedModuleType::Singleton,
  CitedModuleType::Application, CitedModuleType::CustomType, CitedModuleType::end_of_list = CustomType
}
 What type of Rosetta module are we providing a citation for? More...
 

Typedef Documentation

typedef utility::pointer::shared_ptr< AuthorNames const > basic::citation_manager::AuthorNamesCOP
typedef utility::pointer::shared_ptr< Citation const > basic::citation_manager::CitationCOP
using basic::citation_manager::CitationManagerCOP = typedef utility::pointer::shared_ptr< CitationManager const >
using basic::citation_manager::CitationManagerOP = typedef utility::pointer::shared_ptr< CitationManager >
typedef utility::pointer::shared_ptr< Citation > basic::citation_manager::CitationOP

Enumeration Type Documentation

The format for writing a citation.

If this is altered, update Citation::get_formatted_citation().

Enumerator
DefaultStyle 
NatureStyle 
end_of_list 

What type of Rosetta module are we providing a citation for?

If this list is added to, then the CitationCollection::get_enumerated_module_type_name() function must be updated.

Enumerator
Mover 
Filter 
ScoreTerm 
ResidueSelector 
TaskOperation 
PackerPalette 
ScoreFunction 
EnergyMethod 
SimpleMetric 
ConstraintGenerator 
NeuralNetwork 
Singleton 
Application 
CustomType 
end_of_list