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>
Public Member Functions | |
| ResidueNameSelector () | |
| 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... | |
| 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 | |
| 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
◆ ResidueNameSelector() [1/3]
| core::select::residue_selector::ResidueNameSelector::ResidueNameSelector | ( | ) |
◆ ResidueNameSelector() [2/3]
| core::select::residue_selector::ResidueNameSelector::ResidueNameSelector | ( | std::string const & | res_name_str | ) |
◆ ResidueNameSelector() [3/3]
| core::select::residue_selector::ResidueNameSelector::ResidueNameSelector | ( | std::string const & | res_name3_str, |
| bool | dummy | ||
| ) |
◆ ~ResidueNameSelector()
|
overridedefault |
Member Function Documentation
◆ apply()
|
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().
◆ class_name()
|
static |
◆ clone()
|
overridevirtual |
Clone operator.
Copy this object and return an owning pointer to the new object.
Implements core::select::residue_selector::ResidueSelector.
◆ get_name()
|
overridevirtual |
Implements core::select::residue_selector::ResidueSelector.
References class_name().
◆ parse_my_tag()
|
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().
◆ provide_xml_schema()
|
static |
◆ set_residue_name3()
| 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().
◆ set_residue_names()
| 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
◆ res_name3_str_
|
private |
Referenced by apply(), parse_my_tag(), and set_residue_name3().
◆ 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
