core::simple_metrics::SimpleMetricFactory Class Reference

#include <SimpleMetricFactory.hh>

Inheritance diagram for core::simple_metrics::SimpleMetricFactory:

Public Member Functions
	SimpleMetricFactory ()
void	factory_register (SimpleMetricCreatorOP creator)
bool	has_type (std::string const &simple_metric_name) const
SimpleMetricOP	new_simple_metric (std::string const &constraint_generator_name, utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) const
void	provide_xml_schema (std::string const &selector_name, utility::tag::XMLSchemaDefinition &xsd) const
	Get the XML schema for a given residue selector. More...
void	define_simple_metric_xml_schema (utility::tag::XMLSchemaDefinition &xsd) const
std::string	get_citation_humanreadable (std::string const &metric_name) const
	Get a human-readable listing of the citations for a given simple metric, by metric name. More...

Static Public Member Functions
static std::string	simple_metric_xml_schema_group_name ()

Private Types
typedef std::map< std::string, SimpleMetricCreatorOP >	CreatorMap

Private Attributes
CreatorMap	creator_map_

Member Typedef Documentation

typedef std::map< std::string, SimpleMetricCreatorOP > core::simple_metrics::SimpleMetricFactory::CreatorMap

private

Constructor & Destructor Documentation

core::simple_metrics::SimpleMetricFactory::SimpleMetricFactory

(

)

Member Function Documentation

void core::simple_metrics::SimpleMetricFactory::define_simple_metric_xml_schema

(

utility::tag::XMLSchemaDefinition &

xsd

)

const

References core::simple_metrics::complex_type_name_for_simple_metric(), creator_map_, and simple_metric_xml_schema_group_name().

void core::simple_metrics::SimpleMetricFactory::factory_register

(

SimpleMetricCreatorOP

creator

)

References creator_map_.

std::string core::simple_metrics::SimpleMetricFactory::get_citation_humanreadable

(

std::string const &

metric_name

)

const

Get a human-readable listing of the citations for a given simple metric, by metric 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_simple_metric().

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

bool core::simple_metrics::SimpleMetricFactory::has_type

(

std::string const &

simple_metric_name

)

const

References creator_map_.

Referenced by new_simple_metric(), protocols::rosetta_scripts::print_information(), and provide_xml_schema().

SimpleMetricOP core::simple_metrics::SimpleMetricFactory::new_simple_metric	(	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 core::simple_metrics::SimpleMetricFactory::provide_xml_schema	(	std::string const &	metric_name,
		utility::tag::XMLSchemaDefinition &	xsd
	)		const

Get the XML schema for a given residue selector.

Get the XML schema for a given simple metric.

Throws an error if the residue selector is unknown to Rosetta.

Author

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

References creator_map_, and has_type().

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

std::string core::simple_metrics::SimpleMetricFactory::simple_metric_xml_schema_group_name ( )

static

Referenced by define_simple_metric_xml_schema(), and protocols::parser::SimpleMetricLoader::provide_xml_schema().

Member Data Documentation

CreatorMap core::simple_metrics::SimpleMetricFactory::creator_map_

private

Referenced by define_simple_metric_xml_schema(), factory_register(), get_citation_humanreadable(), has_type(), new_simple_metric(), and provide_xml_schema().

---

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

• src/core/simple_metrics/SimpleMetricFactory.hh
• src/core/simple_metrics/SimpleMetricFactory.cc