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
protocols::residue_selectors::StoredResidueSubsetSelector Class Reference

The StoredResidueSubsetSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which are located near the given selected residues in primary sequence space. More...

#include <StoredResidueSubsetSelector.hh>

Inheritance diagram for protocols::residue_selectors::StoredResidueSubsetSelector:
Inheritance graph
[legend]

Public Member Functions

 StoredResidueSubsetSelector ()
 
 StoredResidueSubsetSelector (std::string const &subset_name)
 
 ~StoredResidueSubsetSelector () override
 
core::select::residue_selector::ResidueSelectorOP clone () const override
 Clone operator. More...
 
core::select::residue_selector::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
 
std::string const & get_subset_name () const
 
- 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 void provide_xml_schema (utility::tag::XMLSchemaDefinition &)
 
static std::string class_name ()
 

Private Attributes

std::string subset_name_
 

Detailed Description

The StoredResidueSubsetSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which are located near the given selected residues in primary sequence space.

Constructor & Destructor Documentation

protocols::residue_selectors::StoredResidueSubsetSelector::StoredResidueSubsetSelector ( )
protocols::residue_selectors::StoredResidueSubsetSelector::StoredResidueSubsetSelector ( std::string const &  subset_name)
protocols::residue_selectors::StoredResidueSubsetSelector::~StoredResidueSubsetSelector ( )
overridedefault

Member Function Documentation

core::select::residue_selector::ResidueSubset protocols::residue_selectors::StoredResidueSubsetSelector::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::Pose::data(), core::select::residue_selector::CachedResidueSubset::get_subset(), core::select::residue_selector::CachedResidueSubset::has_subset(), protocols::residue_selectors::quit_no_subset(), core::pose::Pose::size(), core::pose::datacache::CacheableDataType::STORED_RESIDUE_SUBSET, and subset_name_.

std::string protocols::residue_selectors::StoredResidueSubsetSelector::class_name ( )
static
core::select::residue_selector::ResidueSelectorOP protocols::residue_selectors::StoredResidueSubsetSelector::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 protocols::residue_selectors::StoredResidueSubsetSelector::get_name ( ) const
overridevirtual
std::string const& protocols::residue_selectors::StoredResidueSubsetSelector::get_subset_name ( ) const
inline

References subset_name_.

void protocols::residue_selectors::StoredResidueSubsetSelector::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 protocols::residue_selectors::quit_no_subset(), and subset_name_.

void protocols::residue_selectors::StoredResidueSubsetSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

Member Data Documentation

std::string protocols::residue_selectors::StoredResidueSubsetSelector::subset_name_
private

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