Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
core::simple_metrics::TestStringMetric Class Reference

Create subclasses for each type of metric. More...

#include <test_classes.hh>

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

Public Member Functions

 TestStringMetric ()
 
std::string calculate (pose::Pose const &) const override
 Calculate the metric. More...
 
std::string metric () const override
 Name of the metric. More...
 
std::string name () const override
 Name of the class. More...
 
SimpleMetricOP clone () const override
 
 TestStringMetric (TestStringMetric const &)=default
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 called by parse_my_tag – should not be used directly More...
 
- Public Member Functions inherited from core::simple_metrics::StringMetric
 StringMetric ()
 
 ~StringMetric () override
 
 StringMetric (StringMetric const &other)
 
void apply (std::string const &out_label, pose::Pose &pose, bool override_existing_data=false) const override
 Calculate the metric and add it to the pose as a score. labeled as out_label. More...
 
std::string cached_calculate (pose::Pose const &pose, bool use_cache, std::string prefix="", std::string suffix="", bool fail_on_missing_cache=true) const
 Grab the data from the pose if it exists or calculate the metric. More...
 
utility::vector1< std::string > get_metric_names () const override
 Get the metric name that this Metric will calculate. More...
 
- Public Member Functions inherited from core::simple_metrics::SimpleMetric
 SimpleMetric (std::string const &simple_metric_type)
 
 ~SimpleMetric () override
 
 SimpleMetric (SimpleMetric const &other)
 
SimpleMetricoperator= (SimpleMetric const &)
 
void apply (pose::Pose &pose, std::string const &prefix="", std::string const &suffix="", bool override_existing_data=false) const
 Calculate the metric and add it to the Score, which is output into a scorefile - labeled as prefix+metric+suffix. More...
 
void set_custom_type (std::string const &custom_type)
 
std::string get_custom_type () const
 Additional setting to prefix/suffix. More...
 
virtual void parse_base_tag (utility::tag::TagCOP tag)
 Parse the base class tag. Keep required interface for parse_my_tag. More...
 
std::string simple_metric_type () const
 
std::string get_final_sm_type () const
 Get the final name of this metric including its simple_metric_type_ name and any set custom type. More...
 
virtual void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...
 

Static Public Member Functions

static std::string name_static ()
 Name of the class for creator. More...
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- Static Public Member Functions inherited from core::simple_metrics::SimpleMetric
static
utility::tag::XMLSchemaComplexTypeGeneratorOP 
complex_type_generator_for_simple_metric (utility::tag::XMLSchemaDefinition &)
 

Detailed Description

Create subclasses for each type of metric.

Constructor & Destructor Documentation

core::simple_metrics::TestStringMetric::TestStringMetric ( )
inline
core::simple_metrics::TestStringMetric::TestStringMetric ( TestStringMetric const &  )
default

Member Function Documentation

std::string core::simple_metrics::TestStringMetric::calculate ( pose::Pose const &  pose) const
inlineoverridevirtual

Calculate the metric.

Calculate and return the value. This function can not store the value. Use the apply function to store the value in the pose.

Implements core::simple_metrics::StringMetric.

SimpleMetricOP core::simple_metrics::TestStringMetric::clone ( ) const
overridevirtual
std::string core::simple_metrics::TestStringMetric::metric ( ) const
inlineoverridevirtual

Name of the metric.

Implements core::simple_metrics::StringMetric.

std::string core::simple_metrics::TestStringMetric::name ( ) const
inlineoverridevirtual

Name of the class.

Implements core::simple_metrics::StringMetric.

References name_static().

std::string core::simple_metrics::TestStringMetric::name_static ( )
static

Name of the class for creator.

Referenced by core::simple_metrics::TestStringMetricCreator::keyname(), and name().

void core::simple_metrics::TestStringMetric::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

called by parse_my_tag – should not be used directly

Implements core::simple_metrics::StringMetric.

References core::simple_metrics::SimpleMetric::parse_base_tag().

void core::simple_metrics::TestStringMetric::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

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