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::SymmetricalResidueSelector Class Reference

The SymmetricalResidueSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which are symmetrically generated residues of the input list. (IE Union) More...

#include <SymmetricalResidueSelector.hh>

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

Public Member Functions

 SymmetricalResidueSelector ()
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
 SymmetricalResidueSelector (core::select::residue_selector::ResidueSelectorCOP const selector)
 
 ~SymmetricalResidueSelector () override
 
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 &) 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_selector (core::select::residue_selector::ResidueSelectorCOP const selector)
 
- 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::select::residue_selector::ResidueSelectorCOP selector_
 

Detailed Description

The SymmetricalResidueSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which are symmetrically generated residues of the input list. (IE Union)

If the Pose is not symmetrical, returns the generated subset from the passed residue selector.

Constructor & Destructor Documentation

core::select::residue_selector::SymmetricalResidueSelector::SymmetricalResidueSelector ( )
core::select::residue_selector::SymmetricalResidueSelector::SymmetricalResidueSelector ( core::select::residue_selector::ResidueSelectorCOP const  selector)
core::select::residue_selector::SymmetricalResidueSelector::~SymmetricalResidueSelector ( )
overridedefault

Member Function Documentation

ResidueSubset core::select::residue_selector::SymmetricalResidueSelector::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 core::pose::symmetry::is_symmetric(), selector_, core::pose::symmetry::symmetry_info(), and core::select::residue_selector::TR().

std::string core::select::residue_selector::SymmetricalResidueSelector::class_name ( )
static
ResidueSelectorOP core::select::residue_selector::SymmetricalResidueSelector::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::SymmetricalResidueSelector::get_name ( ) const
overridevirtual
void core::select::residue_selector::SymmetricalResidueSelector::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::select::residue_selector::get_residue_selector(), selector_, set_selector(), and core::select::residue_selector::TR().

void core::select::residue_selector::SymmetricalResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::SymmetricalResidueSelector::set_selector ( core::select::residue_selector::ResidueSelectorCOP const  selector)

References selector_.

Referenced by parse_my_tag().

Member Data Documentation

core::select::residue_selector::ResidueSelectorCOP core::select::residue_selector::SymmetricalResidueSelector::selector_
private

Referenced by apply(), parse_my_tag(), and set_selector().


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