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

The JumpUpstreamSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which lie upstream of a given jump in the FoldTree. The jump is specified by its integer index. More...

#include <JumpUpstreamSelector.hh>

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

Public Member Functions

 JumpUpstreamSelector ()
 
 JumpUpstreamSelector (JumpUpstreamSelector const &src)
 Copy constructor. More...
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
 JumpUpstreamSelector (int jump)
 
 ~JumpUpstreamSelector () 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_jump (int jump)
 sets the string by which residues are selected More...
 
- 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

int jump_
 

Detailed Description

The JumpUpstreamSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which lie upstream of a given jump in the FoldTree. The jump is specified by its integer index.

Constructor & Destructor Documentation

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

Copy constructor.

core::select::residue_selector::JumpUpstreamSelector::JumpUpstreamSelector ( int  jump)

References jump_.

core::select::residue_selector::JumpUpstreamSelector::~JumpUpstreamSelector ( )
overridedefault

Member Function Documentation

ResidueSubset core::select::residue_selector::JumpUpstreamSelector::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::fold_tree(), jump_, core::kinematics::FoldTree::partition_by_jump(), and core::pose::Pose::size().

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

void core::select::residue_selector::JumpUpstreamSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::JumpUpstreamSelector::set_jump ( int  jump)

sets the string by which residues are selected

References jump_.

Referenced by parse_my_tag().

Member Data Documentation

int core::select::residue_selector::JumpUpstreamSelector::jump_
private

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