#include <test_classes.hh>

Inheritance diagram for core::simple_metrics::TestCompositeRealMetric:

Public Member Functions
	TestCompositeRealMetric ()

std::map< std::string, core::Real >	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

utility::vector1< std::string >	get_metric_names () const override
	Get the submetric names that this Metric will calculate. More...

	TestCompositeRealMetric (TestCompositeRealMetric 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::CompositeRealMetric
	CompositeRealMetric ()

	~CompositeRealMetric () override

	CompositeRealMetric (CompositeRealMetric 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 SimpleMetricData cache in the pose. labeled as out_label. More...

std::map< std::string, core::Real >	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...

Public Member Functions inherited from core::simple_metrics::SimpleMetric
	SimpleMetric (std::string const &simple_metric_type)

	~SimpleMetric () override

	SimpleMetric (SimpleMetric const &other)

SimpleMetric &	operator= (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 ()

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

Constructor & Destructor Documentation

core::simple_metrics::TestCompositeRealMetric::TestCompositeRealMetric ( )

inline

core::simple_metrics::TestCompositeRealMetric::TestCompositeRealMetric ( TestCompositeRealMetric const & )

default

Member Function Documentation

std::map< std::string, core::Real> core::simple_metrics::TestCompositeRealMetric::calculate ( pose::Pose const & pose ) const

inlineoverridevirtual

Calculate the metric.

Return by value as this function can not STORE the result, it only calculates. Store the result in the pose by using the apply method, which calls this method and stores the result in the pose as ExtraScoreValues.

Implements core::simple_metrics::CompositeRealMetric.

SimpleMetricOP core::simple_metrics::TestCompositeRealMetric::clone ( ) const

overridevirtual

Implements core::simple_metrics::CompositeRealMetric.

utility::vector1< std::string > core::simple_metrics::TestCompositeRealMetric::get_metric_names ( ) const

inlineoverridevirtual

Get the submetric names that this Metric will calculate.

Implements core::simple_metrics::CompositeRealMetric.

std::string core::simple_metrics::TestCompositeRealMetric::metric ( ) const

inlineoverridevirtual

Name of the metric.

Implements core::simple_metrics::CompositeRealMetric.