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::select::residue_selector::OrResidueSelector Class Reference

The OrResidueSelector combines the output of multiple ResidueSelectors using OR logic, i.e., residues selected by ANY of the contained ResidueSelectors will be selected. ResidueSelecters can be pulled in from a DataMap, from subtags (for ResidueSelectors known to the ResidueSelectorFactory) or programmatically through add_residue_selector. More...

#include <OrResidueSelector.hh>

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

Public Member Functions

 OrResidueSelector ()
 
 OrResidueSelector (OrResidueSelector const &src)
 Copy constructor. More...
 
 OrResidueSelector (ResidueSelectorCOP selector1, ResidueSelectorCOP selector2)
 
 ~OrResidueSelector () override
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
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 add_residue_selector (ResidueSelectorCOP selector)
 adds a ResidueSelector More...
 
Size num_selectors () const
 
void apply_or_to_subset (ResidueSubset const &newSubset, ResidueSubset &existingSubset) const
 applies newSubset to existingSubset and thereby modifies the latter More...
 
void provide_citation_info (basic::citation_manager::CitationCollectionList &) const override
 Provide the citation. More...
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. More...
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Attributes

std::list< ResidueSelectorCOPselectors_
 

Detailed Description

The OrResidueSelector combines the output of multiple ResidueSelectors using OR logic, i.e., residues selected by ANY of the contained ResidueSelectors will be selected. ResidueSelecters can be pulled in from a DataMap, from subtags (for ResidueSelectors known to the ResidueSelectorFactory) or programmatically through add_residue_selector.

Constructor & Destructor Documentation

core::select::residue_selector::OrResidueSelector::OrResidueSelector ( )
default
core::select::residue_selector::OrResidueSelector::OrResidueSelector ( OrResidueSelector const &  src)

Copy constructor.

core::select::residue_selector::OrResidueSelector::OrResidueSelector ( ResidueSelectorCOP  selector1,
ResidueSelectorCOP  selector2 
)
core::select::residue_selector::OrResidueSelector::~OrResidueSelector ( )
overridedefault

Member Function Documentation

void core::select::residue_selector::OrResidueSelector::add_residue_selector ( ResidueSelectorCOP  selector)

adds a ResidueSelector

References selectors_.

Referenced by OrResidueSelector(), and parse_my_tag().

ResidueSubset core::select::residue_selector::OrResidueSelector::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 apply_or_to_subset(), num_selectors(), selectors_, and core::pose::Pose::size().

void core::select::residue_selector::OrResidueSelector::apply_or_to_subset ( ResidueSubset const &  newSubset,
ResidueSubset existingSubset 
) const

applies newSubset to existingSubset and thereby modifies the latter

Referenced by apply(), and core::pose::carbohydrates::get_resnums_from_glycan_positions().

std::string core::select::residue_selector::OrResidueSelector::class_name ( )
static
ResidueSelectorOP core::select::residue_selector::OrResidueSelector::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::OrResidueSelector::get_name ( ) const
overridevirtual
Size core::select::residue_selector::OrResidueSelector::num_selectors ( ) const

References selectors_.

Referenced by apply().

void core::select::residue_selector::OrResidueSelector::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 add_residue_selector(), and core::select::residue_selector::get_residue_selector().

void core::select::residue_selector::OrResidueSelector::provide_citation_info ( basic::citation_manager::CitationCollectionList &  citations) const
overridevirtual

Provide the citation.

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

References selectors_.

void core::select::residue_selector::OrResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

Member Data Documentation

std::list< ResidueSelectorCOP > core::select::residue_selector::OrResidueSelector::selectors_
private

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