A simple metric that allows an arbitrary, user- or developer-set floating-point value to be cached in a pose. More...

#include <CustomRealValueMetric.hh>

Inheritance diagram for core::simple_metrics::metrics::CustomRealValueMetric:

[legend]

Public Member Functions
	CustomRealValueMetric ()
	Constructors ///. More...

	CustomRealValueMetric (CustomRealValueMetric const &src)
	Copy constructor (not needed unless you need deep copies) More...

	~CustomRealValueMetric () override
	Destructor (important for properly forward-declaring smart-pointer members) More...

core::Real	calculate (core::pose::Pose const &pose) const override
	Metric Methods ///. More...

void	set_value (core::Real const value_in)
	Set the value that we're going to cache in the pose. More...

std::string	name () const override
	Name of the class. More...

std::string	metric () const override
	Name of the metric. More...

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
	called by parse_my_tag – should not be used directly More...

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

void	provide_citation_info (basic::citation_manager::CitationCollectionList &citations) const override
	Provide the citation. More...

Public Member Functions inherited from core::simple_metrics::RealMetric
	RealMetric ()

	~RealMetric () override

	RealMetric (RealMetric const &other)

RealMetric &	operator= (RealMetric const &)

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

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

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

virtual void	apply (std::string const &out_label, pose::Pose &pose, bool override_existing_data=false) const=0
	Calculate the metric and add it to the Score, which is output into a scorefile - labeled as `label` Must be implemented by derived classes. More...

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

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

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

Private Attributes
core::Real	value_ = 0.0
	The cached value. More...

Detailed Description

A simple metric that allows an arbitrary, user- or developer-set floating-point value to be cached in a pose.

Constructor & Destructor Documentation

◆ CustomRealValueMetric() [1/2]

core::simple_metrics::metrics::CustomRealValueMetric::CustomRealValueMetric ( )

Constructors ///.

Default constructor

◆ CustomRealValueMetric() [2/2]

core::simple_metrics::metrics::CustomRealValueMetric::CustomRealValueMetric ( CustomRealValueMetric const & src )

default

Copy constructor (not needed unless you need deep copies)

Copy constructor.

◆ ~CustomRealValueMetric()

core::simple_metrics::metrics::CustomRealValueMetric::~CustomRealValueMetric ( )

override

Destructor (important for properly forward-declaring smart-pointer members)

Member Function Documentation

◆ calculate()

core::Real core::simple_metrics::metrics::CustomRealValueMetric::calculate ( core::pose::Pose const & pose ) const

overridevirtual

Metric Methods ///.

Calculate the metric.

Returns the cached value.

Implements core::simple_metrics::RealMetric.

References value_.

◆ clone()

core::simple_metrics::SimpleMetricOP core::simple_metrics::metrics::CustomRealValueMetric::clone ( ) const

overridevirtual

Implements core::simple_metrics::RealMetric.

◆ metric()

std::string core::simple_metrics::metrics::CustomRealValueMetric::metric ( ) const

overridevirtual

Name of the metric.

Implements core::simple_metrics::RealMetric.

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

◆ name()

std::string core::simple_metrics::metrics::CustomRealValueMetric::name ( ) const

overridevirtual

Name of the class.

Implements core::simple_metrics::RealMetric.

References name_static().

◆ name_static()

std::string core::simple_metrics::metrics::CustomRealValueMetric::name_static ( )

static

Name of the class for creator.

Referenced by core::simple_metrics::metrics::CustomRealValueMetricCreator::keyname(), name(), and provide_xml_schema().

◆ parse_my_tag()

void core::simple_metrics::metrics::CustomRealValueMetric::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::RealMetric.

References core::simple_metrics::SimpleMetric::parse_base_tag(), and set_value().

◆ provide_citation_info()

void core::simple_metrics::metrics::CustomRealValueMetric::provide_citation_info ( basic::citation_manager::CitationCollectionList & citations ) const

overridevirtual

Provide the citation.

Reimplemented from core::simple_metrics::SimpleMetric.

◆ provide_xml_schema()

void core::simple_metrics::metrics::CustomRealValueMetric::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

References name_static(), and core::simple_metrics::xsd_simple_metric_type_definition_w_attributes().

Referenced by core::simple_metrics::metrics::CustomRealValueMetricCreator::provide_xml_schema().

◆ set_value()

void core::simple_metrics::metrics::CustomRealValueMetric::set_value ( core::Real const value_in )

inline

Set the value that we're going to cache in the pose.

References value_.

Referenced by parse_my_tag().

Member Data Documentation

◆ value_

core::Real core::simple_metrics::metrics::CustomRealValueMetric::value_ = 0.0

private

The cached value.

Referenced by calculate(), and set_value().

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

src/core/simple_metrics/metrics/CustomRealValueMetric.hh
src/core/simple_metrics/metrics/CustomRealValueMetric.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CustomRealValueMetric() [1/2]

◆ CustomRealValueMetric() [2/2]

◆ ~CustomRealValueMetric()

Member Function Documentation

◆ calculate()

◆ clone()

◆ metric()

◆ name()

◆ name_static()

◆ parse_my_tag()

◆ provide_citation_info()

◆ provide_xml_schema()

◆ set_value()

Member Data Documentation

◆ value_