protocols::constraint_generator::ConstraintGeneratorFactory Class Reference

#include <ConstraintGeneratorFactory.hh>

Inheritance diagram for protocols::constraint_generator::ConstraintGeneratorFactory:

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

CreatorMap

typedef std::map< std::string, ConstraintGeneratorCreatorOP > protocols::constraint_generator::ConstraintGeneratorFactory::CreatorMap

private

Constructor & Destructor Documentation

ConstraintGeneratorFactory()

protocols::constraint_generator::ConstraintGeneratorFactory::ConstraintGeneratorFactory

(

)

Member Function Documentation

complex_type_name_for_constraint_generator()

std::string protocols::constraint_generator::ConstraintGeneratorFactory::complex_type_name_for_constraint_generator ( std::string const &  constraint_name )

static

Referenced by define_constraint_generator_xml_schema_group(), protocols::fold_from_loops::constraint_generator::SegmentedAtomPairConstraintGenerator::provide_xml_schema(), and xsd_constraint_generator_type_definition_w_attributes().

constraint_generator_xml_schema_group_name()

std::string protocols::constraint_generator::ConstraintGeneratorFactory::constraint_generator_xml_schema_group_name ( )

static

Referenced by define_constraint_generator_xml_schema_group(), protocols::constraint_generator::AddConstraints::provide_xml_schema(), and protocols::parser::ConstraintGeneratorLoader::provide_xml_schema().

define_constraint_generator_xml_schema_group()

void protocols::constraint_generator::ConstraintGeneratorFactory::define_constraint_generator_xml_schema_group

(

utility::tag::XMLSchemaDefinition &

xsd

)

const

References complex_type_name_for_constraint_generator(), constraint_generator_xml_schema_group_name(), and creator_map_.

factory_register()

void protocols::constraint_generator::ConstraintGeneratorFactory::factory_register

(

ConstraintGeneratorCreatorOP

creator

)

References creator_map_.

get_citation_humanreadable()

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(), and xsd_constraint_generator_type_definition_w_attributes().

has_type()

bool protocols::constraint_generator::ConstraintGeneratorFactory::has_type

(

std::string const &

constraint_generator_name

)

const

References creator_map_.

Referenced by new_constraint_generator(), and protocols::rosetta_scripts::print_information().

new_constraint_generator()

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().

provide_xml_schema()

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().

xsd_constraint_generator_type_definition_w_attributes()

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

References complex_type_name_for_constraint_generator(), and get_citation_humanreadable().

Referenced by protocols::constraint_generator::AtomPairConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::CoordinateConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::DihedralConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::DistanceConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::HydrogenBondConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::MembraneSpanConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::MetalContactsConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::ResidueTypeConstraintGenerator::provide_xml_schema(), protocols::constraint_generator::TerminiConstraintGenerator::provide_xml_schema(), protocols::denovo_design::constraints::FileConstraintGenerator::provide_xml_schema(), protocols::fldsgn::SheetConstraintGenerator::provide_xml_schema(), and protocols::trRosetta_protocols::constraint_generators::trRosettaConstraintGenerator::provide_xml_schema().

Member Data Documentation

creator_map_

CreatorMap protocols::constraint_generator::ConstraintGeneratorFactory::creator_map_

private

Referenced by define_constraint_generator_xml_schema_group(), factory_register(), get_citation_humanreadable(), has_type(), new_constraint_generator(), and provide_xml_schema().

---

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

• src/protocols/constraint_generator/ConstraintGeneratorFactory.hh
• src/protocols/constraint_generator/ConstraintGeneratorFactory.cc