Rosetta  2020.37
 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::ResidueSpanSelector Class Reference

The ResidueSpanSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which are within a given span. A span is defined by start and end point, each as either Rosetta indices (e.g. 10) or PDB numbers (e.g. 10A, residue 10 of chain A). Detection and mapping from PDB to Rosetta residue numbers is done internally. (The span is defined based on Rosetta indicies, even if residues are given by PDB numbers.) More...

#include <ResidueSpanSelector.hh>

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

Public Member Functions

 ResidueSpanSelector ()
 
 ResidueSpanSelector (ResidueSpanSelector const &src)
 Copy constructor. More...
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
 ResidueSpanSelector (core::pose::ResidueIndexDescriptionCOP start, core::pose::ResidueIndexDescriptionCOP end)
 
 ResidueSpanSelector (std::string const &start_str, std::string const &end_str)
 
 ResidueSpanSelector (core::Size start, core::Size end)
 
 ~ResidueSpanSelector () 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_span (std::string const &start, std::string const &end)
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. More...
 
virtual bool residue_selector_provides_citation_info () const
 Does this residue selector provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool residue_selector_is_unpublished () const
 Does this residue selector indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

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

Private Attributes

core::pose::ResidueIndexDescriptionCOP start_
 
core::pose::ResidueIndexDescriptionCOP end_
 

Detailed Description

The ResidueSpanSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which are within a given span. A span is defined by start and end point, each as either Rosetta indices (e.g. 10) or PDB numbers (e.g. 10A, residue 10 of chain A). Detection and mapping from PDB to Rosetta residue numbers is done internally. (The span is defined based on Rosetta indicies, even if residues are given by PDB numbers.)

Constructor & Destructor Documentation

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

Copy constructor.

core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector ( core::pose::ResidueIndexDescriptionCOP  start,
core::pose::ResidueIndexDescriptionCOP  end 
)
core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector ( std::string const &  start_str,
std::string const &  end_str 
)
core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector ( core::Size  start,
core::Size  end 
)
core::select::residue_selector::ResidueSpanSelector::~ResidueSpanSelector ( )
overridedefault

Member Function Documentation

ResidueSubset core::select::residue_selector::ResidueSpanSelector::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::sequence::end, end_, core::pose::Pose::size(), protocols::loops::start, start_, and core::select::residue_selector::TR().

std::string core::select::residue_selector::ResidueSpanSelector::class_name ( )
static
ResidueSelectorOP core::select::residue_selector::ResidueSpanSelector::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::ResidueSpanSelector::get_name ( ) const
overridevirtual
void core::select::residue_selector::ResidueSpanSelector::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 set_span().

void core::select::residue_selector::ResidueSpanSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::ResidueSpanSelector::set_span ( std::string const &  start,
std::string const &  end 
)

References end_, core::pose::parse_resnum(), and start_.

Referenced by parse_my_tag().

Member Data Documentation

core::pose::ResidueIndexDescriptionCOP core::select::residue_selector::ResidueSpanSelector::end_
private

Referenced by apply(), and set_span().

core::pose::ResidueIndexDescriptionCOP core::select::residue_selector::ResidueSpanSelector::start_
private

Referenced by apply(), and set_span().


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