Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
core::select::residue_selector::SimpleMetricSelector Class Reference

The SimpleMetricSelector allows conditional application of a residue selector. More...

#include <SimpleMetricSelector.hh>

Inheritance diagram for core::select::residue_selector::SimpleMetricSelector:
Inheritance graph
[legend]

Public Member Functions

 SimpleMetricSelector (SimpleMetricSelector const &src)
 Copy constructor. More...
 
 ~SimpleMetricSelector () override
 
SimpleMetricSelectoroperator= (SimpleMetricSelector const &ot)
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
 SimpleMetricSelector (core::simple_metrics::PerResidueRealMetricCOP metric=nullptr, Real lower_bound=utility::get_undefined_real(), Real upper_bound=utility::get_undefined_real(), bool outside_bounds=false)
 
ResidueSubset apply (core::pose::Pose const &pose) const override
 Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) override
 Initialize any data members of this instance from an input tag and a DataMap object. More...
 
std::string get_name () const override
 
void set_metric (core::simple_metrics::PerResidueRealMetricCOP const &metric)
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. 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 class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Attributes

core::simple_metrics::PerResidueRealMetricCOP metric_
 
Real lower_bound_
 
Real upper_bound_
 
bool outside_bounds_
 

Friends

class ::SimpleMetricSelectorTests
 

Detailed Description

The SimpleMetricSelector allows conditional application of a residue selector.

Constructor & Destructor Documentation

core::select::residue_selector::SimpleMetricSelector::SimpleMetricSelector ( SimpleMetricSelector const &  src)

Copy constructor.

core::select::residue_selector::SimpleMetricSelector::~SimpleMetricSelector ( )
overridedefault
core::select::residue_selector::SimpleMetricSelector::SimpleMetricSelector ( core::simple_metrics::PerResidueRealMetricCOP  metric = nullptr,
Real  lower_bound = utility::get_undefined_real(),
Real  upper_bound = utility::get_undefined_real(),
bool  outside_bounds = false 
)

References set_metric().

Member Function Documentation

ResidueSubset core::select::residue_selector::SimpleMetricSelector::apply ( core::pose::Pose const &  pose) const
overridevirtual

Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not.

Implements core::select::residue_selector::ResidueSelector.

References lower_bound_, metric_, outside_bounds_, core::scoring::pair, core::pose::Pose::size(), and upper_bound_.

std::string core::select::residue_selector::SimpleMetricSelector::class_name ( )
static
ResidueSelectorOP core::select::residue_selector::SimpleMetricSelector::clone ( ) const
overridevirtual

Clone operator.

Copy this object and return an owning pointer to the new object.

Implements core::select::residue_selector::ResidueSelector.

std::string core::select::residue_selector::SimpleMetricSelector::get_name ( ) const
overridevirtual
SimpleMetricSelector & core::select::residue_selector::SimpleMetricSelector::operator= ( SimpleMetricSelector const &  ot)
void core::select::residue_selector::SimpleMetricSelector::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  datacache 
)
overridevirtual

Initialize any data members of this instance from an input tag and a DataMap object.

Noop implementation in the base class in the case that a derived class has no need to read data from an input tag

Reimplemented from core::select::residue_selector::ResidueSelector.

References core::simple_metrics::get_metric_from_datamap_and_subtags(), core::select::residue_selector::has_option(), lower_bound_, outside_bounds_, set_metric(), and upper_bound_.

void core::select::residue_selector::SimpleMetricSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::SimpleMetricSelector::set_metric ( core::simple_metrics::PerResidueRealMetricCOP const &  metric)

References metric_.

Referenced by parse_my_tag(), and SimpleMetricSelector().

Friends And Related Function Documentation

friend class ::SimpleMetricSelectorTests
friend

Member Data Documentation

Real core::select::residue_selector::SimpleMetricSelector::lower_bound_
private

Referenced by apply(), operator=(), and parse_my_tag().

core::simple_metrics::PerResidueRealMetricCOP core::select::residue_selector::SimpleMetricSelector::metric_
private

Referenced by apply(), operator=(), and set_metric().

bool core::select::residue_selector::SimpleMetricSelector::outside_bounds_
private

Referenced by apply(), operator=(), and parse_my_tag().

Real core::select::residue_selector::SimpleMetricSelector::upper_bound_
private

Referenced by apply(), operator=(), and parse_my_tag().


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