core::select::residue_selector::ResidueNameSelector Class Reference

The ResidueNameSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which match the given residue index. The index is read as comma-separated list of 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. More...

#include <ResidueNameSelector.hh>

Inheritance diagram for core::select::residue_selector::ResidueNameSelector:

Public Member Functions
	ResidueNameSelector ()
	ResidueNameSelector (ResidueNameSelector const &src)
	Copy constructor. More...
	ResidueNameSelector (std::string const &res_name_str)
	ResidueNameSelector (std::string const &res_name3_str, bool dummy)
	~ResidueNameSelector () override
ResidueSelectorOP	clone () const override
	Clone operator. More...
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_residue_names (std::string const &res_name_str)
	sets the comma-separated string of residue names to be selected More...
void	set_residue_name3 (std::string const &res_name3_str)
	sets the comma-separated string of 3-character residue names to be 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
std::string	res_name_str_
std::string	res_name3_str_

Detailed Description

The ResidueNameSelector returns a ResidueSubset, i.e. a utility::vector1< bool > containing 'true' for residue positions which match the given residue index. The index is read as comma-separated list of 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.

Constructor & Destructor Documentation

core::select::residue_selector::ResidueNameSelector::ResidueNameSelector

(

)

core::select::residue_selector::ResidueNameSelector::ResidueNameSelector

(

ResidueNameSelector const &

src

)

Copy constructor.

core::select::residue_selector::ResidueNameSelector::ResidueNameSelector

(

std::string const &

res_name_str

)

core::select::residue_selector::ResidueNameSelector::ResidueNameSelector	(	std::string const &	res_name3_str,
		bool	dummy
	)

core::select::residue_selector::ResidueNameSelector::~ResidueNameSelector ( )

overridedefault

Member Function Documentation

ResidueSubset core::select::residue_selector::ResidueNameSelector::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::conformation::Residue::name(), core::conformation::Residue::name3(), res_name3_str_, res_name_str_, core::pose::Pose::residue(), core::pose::Pose::residue_type_set_for_pose(), and core::pose::Pose::size().

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

static

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

ResidueSelectorOP core::select::residue_selector::ResidueNameSelector::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::ResidueNameSelector::get_name ( ) const

overridevirtual

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

References class_name().

void core::select::residue_selector::ResidueNameSelector::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 res_name3_str_, res_name_str_, set_residue_name3(), and set_residue_names().

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

static

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

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

void core::select::residue_selector::ResidueNameSelector::set_residue_name3

(

std::string const &

res_name3_str

)

sets the comma-separated string of 3-character residue names to be selected

References res_name3_str_.

Referenced by parse_my_tag().

void core::select::residue_selector::ResidueNameSelector::set_residue_names

(

std::string const &

res_name_str

)

sets the comma-separated string of residue names to be selected

References res_name_str_.

Referenced by parse_my_tag().

Member Data Documentation

std::string core::select::residue_selector::ResidueNameSelector::res_name3_str_

private

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

std::string core::select::residue_selector::ResidueNameSelector::res_name_str_

private

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

---

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

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