Rosetta  2021.16
 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
core::simple_metrics::metrics::SelectedResiduesMetric Class Reference

Output residue-selected residues to a score file as rosetta resnums or pdbnums. More...

#include <SelectedResiduesMetric.hh>

Inheritance diagram for core::simple_metrics::metrics::SelectedResiduesMetric:
Inheritance graph
[legend]

Public Member Functions

 SelectedResiduesMetric ()
 Constructors ///. More...
 
 SelectedResiduesMetric (select::residue_selector::ResidueSelectorCOP selector)
 
 SelectedResiduesMetric (SelectedResiduesMetric const &src)
 Copy constructor (not needed unless you need deep copies) More...
 
 ~SelectedResiduesMetric () override
 Destructor (important for properly forward-declaring smart-pointer members) More...
 
std::string calculate (core::pose::Pose const &pose) const override
 Metric Methods ///. More...
 
void set_residue_selector (select::residue_selector::ResidueSelectorCOP selector)
 Set the required residue selector. More...
 
void set_output_in_rosetta_num (bool output_in_rosetta_num)
 Set the mode in which we will output the selected residues. More...
 
std::string name () const override
 Name of the class. More...
 
std::string metric () const override
 Name of the metric. More...
 
void provide_citation_info (basic::citation_manager::CitationCollectionList &) const override
 Provide the citation. 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::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...
 

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

select::residue_selector::ResidueSelectorCOP selector_ = nullptr
 
bool rosetta_nums_ = false
 

Detailed Description

Output residue-selected residues to a score file as rosetta resnums or pdbnums.

Constructor & Destructor Documentation

core::simple_metrics::metrics::SelectedResiduesMetric::SelectedResiduesMetric ( )

Constructors ///.

Default constructor

core::simple_metrics::metrics::SelectedResiduesMetric::SelectedResiduesMetric ( select::residue_selector::ResidueSelectorCOP  selector)
core::simple_metrics::metrics::SelectedResiduesMetric::SelectedResiduesMetric ( SelectedResiduesMetric const &  src)

Copy constructor (not needed unless you need deep copies)

Copy constructor.

References selector_.

core::simple_metrics::metrics::SelectedResiduesMetric::~SelectedResiduesMetric ( )
override

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

Member Function Documentation

std::string core::simple_metrics::metrics::SelectedResiduesMetric::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. Output a comma-separated list of residues either in PDB (default) or Rosetta numbers.

Implements core::simple_metrics::StringMetric.

References core::select::get_residues_from_subset(), core::pose::Pose::pdb_info(), rosetta_nums_, selector_, and core::id::to_string().

core::simple_metrics::SimpleMetricOP core::simple_metrics::metrics::SelectedResiduesMetric::clone ( ) const
overridevirtual
std::string core::simple_metrics::metrics::SelectedResiduesMetric::metric ( ) const
overridevirtual

Name of the metric.

Implements core::simple_metrics::StringMetric.

std::string core::simple_metrics::metrics::SelectedResiduesMetric::name ( ) const
overridevirtual

Name of the class.

Implements core::simple_metrics::StringMetric.

References name_static().

Referenced by provide_citation_info().

std::string core::simple_metrics::metrics::SelectedResiduesMetric::name_static ( )
static
void core::simple_metrics::metrics::SelectedResiduesMetric::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual
void core::simple_metrics::metrics::SelectedResiduesMetric::provide_citation_info ( basic::citation_manager::CitationCollectionList &  citations) const
overridevirtual

Provide the citation.

Reimplemented from core::simple_metrics::SimpleMetric.

References name(), and selector_.

void core::simple_metrics::metrics::SelectedResiduesMetric::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::simple_metrics::metrics::SelectedResiduesMetric::set_output_in_rosetta_num ( bool  output_in_rosetta_num)

Set the mode in which we will output the selected residues.

References rosetta_nums_.

Referenced by parse_my_tag().

void core::simple_metrics::metrics::SelectedResiduesMetric::set_residue_selector ( select::residue_selector::ResidueSelectorCOP  selector)

Set the required residue selector.

References selector_.

Referenced by parse_my_tag(), and SelectedResiduesMetric().

Member Data Documentation

bool core::simple_metrics::metrics::SelectedResiduesMetric::rosetta_nums_ = false
private
select::residue_selector::ResidueSelectorCOP core::simple_metrics::metrics::SelectedResiduesMetric::selector_ = nullptr
private

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