Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
protocols::constraint_generator::ConstraintGeneratorFactory Class Reference

#include <ConstraintGeneratorFactory.hh>

Inheritance diagram for protocols::constraint_generator::ConstraintGeneratorFactory:
Inheritance graph
[legend]

Public Member Functions

 ConstraintGeneratorFactory ()
 
void factory_register (ConstraintGeneratorCreatorOP creator)
 
bool has_type (std::string const &constraint_generator_name) const
 
ConstraintGeneratorOP new_constraint_generator (std::string const &constraint_generator_name, utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) const
 
void provide_xml_schema (std::string const &cst_generator_name, utility::tag::XMLSchemaDefinition &xsd) const
 Get the XML schema for a given constraint generator. More...
 
void define_constraint_generator_xml_schema_group (utility::tag::XMLSchemaDefinition &xsd) const
 
std::string get_citation_humanreadable (std::string const &cst_generator_name) const
 Get a human-readable listing of the citations for a given cst generator, by generator name. More...
 

Static Public Member Functions

static std::string constraint_generator_xml_schema_group_name ()
 
static std::string complex_type_name_for_constraint_generator (std::string const &constraint_name)
 
static void xsd_constraint_generator_type_definition_w_attributes (utility::tag::XMLSchemaDefinition &xsd, std::string const &constraint_type, std::string const &description, utility::tag::AttributeList const &attributes)
 

Private Types

typedef std::map< std::string,
ConstraintGeneratorCreatorOP
CreatorMap
 

Private Attributes

CreatorMap creator_map_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::constraint_generator::ConstraintGeneratorFactory::ConstraintGeneratorFactory ( )

Member Function Documentation

std::string protocols::constraint_generator::ConstraintGeneratorFactory::complex_type_name_for_constraint_generator ( std::string const &  constraint_name)
static
std::string protocols::constraint_generator::ConstraintGeneratorFactory::constraint_generator_xml_schema_group_name ( )
static
void protocols::constraint_generator::ConstraintGeneratorFactory::define_constraint_generator_xml_schema_group ( utility::tag::XMLSchemaDefinition &  xsd) const
void protocols::constraint_generator::ConstraintGeneratorFactory::factory_register ( ConstraintGeneratorCreatorOP  creator)

References creator_map_.

std::string protocols::constraint_generator::ConstraintGeneratorFactory::get_citation_humanreadable ( std::string const &  constraint_generator_name) const

Get a human-readable listing of the citations for a given cst generator, by generator name.

Get a human-readable listing of the citations for a given filter, by filter name.

Returns an empty string if there are no citations.

Author
Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org).

References creator_map_, and new_constraint_generator().

Referenced by protocols::rosetta_scripts::print_information().

bool protocols::constraint_generator::ConstraintGeneratorFactory::has_type ( std::string const &  constraint_generator_name) const
ConstraintGeneratorOP protocols::constraint_generator::ConstraintGeneratorFactory::new_constraint_generator ( std::string const &  constraint_generator_name,
utility::tag::TagCOP  tag,
basic::datacache::DataMap &  datamap 
) const

References creator_map_, and has_type().

Referenced by get_citation_humanreadable().

void protocols::constraint_generator::ConstraintGeneratorFactory::provide_xml_schema ( std::string const &  cst_generator_name,
utility::tag::XMLSchemaDefinition &  xsd 
) const

Get the XML schema for a given constraint generator.

Throws an error if the constraint generator is unknown to Rosetta.

Author
Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu)

References creator_map_, and protocols::constraint_generator::TR().

Referenced by protocols::rosetta_scripts::print_information().

void protocols::constraint_generator::ConstraintGeneratorFactory::xsd_constraint_generator_type_definition_w_attributes ( utility::tag::XMLSchemaDefinition &  xsd,
std::string const &  constraint_type,
std::string const &  description,
utility::tag::AttributeList const &  attributes 
)
static

Member Data Documentation

CreatorMap protocols::constraint_generator::ConstraintGeneratorFactory::creator_map_
private

The documentation for this class was generated from the following files: