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:

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...
utility::vector1< core::Size >	selection_positions (core::pose::Pose const &pose) const
	Calls apply and returns the Rosetta numbering corresponding to the selected residues. 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::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

ResidueSpanSelector() [1/5]

core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector ( )

default

ResidueSpanSelector() [2/5]

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

default

Copy constructor.

ResidueSpanSelector() [3/5]

core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector	(	core::pose::ResidueIndexDescriptionCOP	start,
		core::pose::ResidueIndexDescriptionCOP	end
	)

ResidueSpanSelector() [4/5]

core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector	(	std::string const &	start_str,
		std::string const &	end_str
	)

ResidueSpanSelector() [5/5]

core::select::residue_selector::ResidueSpanSelector::ResidueSpanSelector	(	core::Size	start,
		core::Size	end
	)

~ResidueSpanSelector()

core::select::residue_selector::ResidueSpanSelector::~ResidueSpanSelector ( )

overridedefault

Member Function Documentation

apply()

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().

class_name()

std::string core::select::residue_selector::ResidueSpanSelector::class_name ( )

static

Referenced by get_name(), core::select::residue_selector::ResidueSpanSelectorCreator::keyname(), and provide_xml_schema().

clone()

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.

get_name()

std::string core::select::residue_selector::ResidueSpanSelector::get_name ( ) const

overridevirtual

Implements core::select::residue_selector::ResidueSelector.

References class_name().

parse_my_tag()

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().

provide_xml_schema()

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

static

References core::pose::attributes_for_parse_resnum(), class_name(), and core::select::residue_selector::xsd_type_definition_w_attributes().

Referenced by core::select::residue_selector::ResidueSpanSelectorCreator::provide_xml_schema().

set_span()

void core::select::residue_selector::ResidueSpanSelector::set_span	(	std::string const &	start,
		std::string const &	end
	)

References core::sequence::end, end_, core::pose::parse_resnum(), protocols::loops::start, and start_.

Referenced by parse_my_tag().

Member Data Documentation

end_

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

private

Referenced by apply(), and set_span().

start_

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:

• src/core/select/residue_selector/ResidueSpanSelector.hh
• src/core/select/residue_selector/ResidueSpanSelector.cc