Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Typedefs | Enumerations | Functions
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  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
 
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::Singleton, CitedModuleType::Application, CitedModuleType::CustomType,
  CitedModuleType::end_of_list = CustomType
}
 What type of Rosetta module are we providing a citation for? More...
 

Functions

bool has_citation_collection (CitationCollection const &collection, utility::vector1< CitationCollectionCOP > const &vec)
 Utility function to determine whether a particular CitationCollection is already in a vector. More...
 
void merge_into_citation_collection_vector (utility::vector1< CitationCollectionCOP > const &source_vector, utility::vector1< CitationCollectionCOP > &destination_vector)
 Utility function that takes all of the citation collections from vector A that are NOT in vector B and appends them to vector B. More...
 
void merge_into_unpublished_collection_vector (utility::vector1< UnpublishedModuleInfoCOP > const &source, utility::vector1< UnpublishedModuleInfoCOP > &destination)
 Helper function that compares two lists of UnpublishedModuleInfoCOPs and appends all the ones from list A that aren't already in list B onto the end of list B. 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 
Singleton 
Application 
CustomType 
end_of_list 

Function Documentation

bool basic::citation_manager::has_citation_collection ( CitationCollection const &  collection,
utility::vector1< CitationCollectionCOP > const &  vec 
)

Utility function to determine whether a particular CitationCollection is already in a vector.

Referenced by merge_into_citation_collection_vector().

void basic::citation_manager::merge_into_citation_collection_vector ( utility::vector1< CitationCollectionCOP > const &  source_vector,
utility::vector1< CitationCollectionCOP > &  destination_vector 
)

Utility function that takes all of the citation collections from vector A that are NOT in vector B and appends them to vector B.

References has_citation_collection().

Referenced by basic::citation_manager::CitationManager::add_citations().

void basic::citation_manager::merge_into_unpublished_collection_vector ( utility::vector1< UnpublishedModuleInfoCOP > const &  source,
utility::vector1< UnpublishedModuleInfoCOP > &  destination 
)

Helper function that compares two lists of UnpublishedModuleInfoCOPs and appends all the ones from list A that aren't already in list B onto the end of list B.

Referenced by basic::citation_manager::CitationManager::add_unpublished_modules().