Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::filters::FilterValueMetric Class Reference

Convert the result of a Filter's report_sm() to a SimpleMetric This is intended primarily as a compatibility shim class for making old code compatible. It's not really intended to be used for new work - write a SimpleMetric directly. More...

#include <FilterValueMetric.hh>

Inheritance diagram for protocols::filters::FilterValueMetric:
Inheritance graph
[legend]

Public Member Functions

 FilterValueMetric ()
 Constructors ///. More...
 
 FilterValueMetric (FilterOP filter)
 Construct based on a given filter. More...
 
core::Real calculate (core::pose::Pose const &pose) const override
 Metric Methods ///. 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
 
- Public Member Functions inherited from core::simple_metrics::RealMetric
 RealMetric ()
 
 ~RealMetric () override
 
 RealMetric (RealMetric const &other)
 
void apply (pose::Pose &pose, std::string prefix="", std::string suffix="", bool override_existing_data=false) const override
 Calculate the metric and add it to the pose as a score. labeled as prefix+metric+suffix. 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...
 
- Public Member Functions inherited from core::simple_metrics::SimpleMetric
 SimpleMetric (std::string const &simple_metric_type)
 
 ~SimpleMetric () override
 
 SimpleMetric (SimpleMetric const &other)
 
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 bool simple_metric_provides_citation_info () const
 Does this simple metric provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool simple_metric_is_unpublished () const
 Does this simple metric indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. 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

protocols::filters::FilterOP filter_
 

Detailed Description

Convert the result of a Filter's report_sm() to a SimpleMetric This is intended primarily as a compatibility shim class for making old code compatible. It's not really intended to be used for new work - write a SimpleMetric directly.

Constructor & Destructor Documentation

protocols::filters::FilterValueMetric::FilterValueMetric ( )

Constructors ///.

Default constructor

protocols::filters::FilterValueMetric::FilterValueMetric ( FilterOP  filter)

Construct based on a given filter.

Member Function Documentation

core::Real protocols::filters::FilterValueMetric::calculate ( core::pose::Pose const &  pose) const
overridevirtual

Metric Methods ///.

Defined in RealMetric:

Calculate the metric and add it to the pose as a score. labeled as prefix+metric+suffix.

Score is added through setExtraScorePose and is output into the score tables/file at pose output. Calculate the metric.

Implements core::simple_metrics::RealMetric.

References filter_.

core::simple_metrics::SimpleMetricOP protocols::filters::FilterValueMetric::clone ( ) const
overridevirtual
std::string protocols::filters::FilterValueMetric::metric ( ) const
overridevirtual

Name of the metric.

Implements core::simple_metrics::RealMetric.

std::string protocols::filters::FilterValueMetric::name ( ) const
overridevirtual

Name of the class.

Implements core::simple_metrics::RealMetric.

References name_static().

std::string protocols::filters::FilterValueMetric::name_static ( )
static

Name of the class for creator.

Referenced by protocols::filters::FilterValueMetricCreator::keyname(), name(), and provide_xml_schema().

void protocols::filters::FilterValueMetric::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 filter_, and protocols::rosetta_scripts::parse_filter().

void protocols::filters::FilterValueMetric::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

Member Data Documentation

protocols::filters::FilterOP protocols::filters::FilterValueMetric::filter_
private

Referenced by calculate(), and parse_my_tag().


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