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
core::simple_metrics::SimpleMetricFactory Class Reference

#include <SimpleMetricFactory.hh>

Inheritance diagram for core::simple_metrics::SimpleMetricFactory:
Inheritance graph
[legend]

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

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
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
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

Member Data Documentation

CreatorMap core::simple_metrics::SimpleMetricFactory::creator_map_
private

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