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

A ResidueSelector for carbohydrates and individual carbohydrate trees. Selects all Glycan residues if no option is given or the branch going out from the root residue. Selecting from root residues allows you to choose the whole glycan branch or only tips, etc. More...

#include <GlycanResidueSelector.hh>

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

Public Member Functions

 GlycanResidueSelector ()
 Constructor. More...
 
 GlycanResidueSelector (utility::vector1< bool > root_residues, bool include_root=false)
 Constructor to select tree residues from branch roots. See set_branch_residues for more. More...
 
 GlycanResidueSelector (core::Size root_residue, bool include_root=false)
 
void set_select_from_branch_residues (utility::vector1< bool > root_residues)
 Set the residue(s) to select from. These can be the branch points of the glycans or carbohydrate residues from which to select the downstream branch from. More...
 
void set_select_from_branch_residue (core::Size root_residue)
 Set the residue to select from. These can be the branch points of the glycans or carbohydrate residues from which to select the downstream branch from. More...
 
void set_include_root (bool include_root)
 Option to include the root(s) we are selecting from. Default FALSE. More...
 
 ~GlycanResidueSelector () override
 Destructor. More...
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
ResidueSubset apply (core::pose::Pose const &pose) const override
 "Apply" function. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) override
 XML parse. More...
 
std::string get_name () const override
 Get the mover class name. More...
 
- 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 ()
 Get the mover class name. More...
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 Provide XSD information, enabling mechanical validation of input XML. More...
 

Private Attributes

utility::vector1< boolroot_residues_
 
core::Size root_residue_
 
utility::vector1< std::string > parsed_positions_
 
std::string ref_pose_name_
 
bool include_root_
 

Detailed Description

A ResidueSelector for carbohydrates and individual carbohydrate trees. Selects all Glycan residues if no option is given or the branch going out from the root residue. Selecting from root residues allows you to choose the whole glycan branch or only tips, etc.

Constructor & Destructor Documentation

core::select::residue_selector::GlycanResidueSelector::GlycanResidueSelector ( )

Constructor.

References include_root_, and root_residue_.

core::select::residue_selector::GlycanResidueSelector::GlycanResidueSelector ( utility::vector1< bool root_residues,
bool  include_root = false 
)

Constructor to select tree residues from branch roots. See set_branch_residues for more.

References root_residue_, and set_select_from_branch_residues().

core::select::residue_selector::GlycanResidueSelector::GlycanResidueSelector ( core::Size  root_residue,
bool  include_root = false 
)
core::select::residue_selector::GlycanResidueSelector::~GlycanResidueSelector ( )
overridedefault

Destructor.

Member Function Documentation

ResidueSubset core::select::residue_selector::GlycanResidueSelector::apply ( core::pose::Pose const &  pose) const
overridevirtual
std::string core::select::residue_selector::GlycanResidueSelector::class_name ( )
static
core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::GlycanResidueSelector::clone ( ) const
overridevirtual

Clone operator.

Clone function.

Copy the current object (creating the copy on the heap) and return an owning pointer to the copy. All ResidueSelectors must implement this.

Copy this object and return owning pointer to the copy (created on the heap).

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

std::string core::select::residue_selector::GlycanResidueSelector::get_name ( ) const
overridevirtual

Get the mover class name.

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

References class_name().

void core::select::residue_selector::GlycanResidueSelector::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  datamap 
)
overridevirtual

XML parse.

Parse RosettaScripts tags and set up this mover.

Reimplemented from core::select::residue_selector::ResidueSelector.

References include_root_, parsed_positions_, and ref_pose_name_.

void core::select::residue_selector::GlycanResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::GlycanResidueSelector::set_include_root ( bool  include_root)

Option to include the root(s) we are selecting from. Default FALSE.

References include_root_.

Referenced by core::select::residue_selector::RandomGlycanFoliageSelector::apply().

void core::select::residue_selector::GlycanResidueSelector::set_select_from_branch_residue ( core::Size  root_residue)

Set the residue to select from. These can be the branch points of the glycans or carbohydrate residues from which to select the downstream branch from.

Like the rest of a tree from a particular position. That position could be the trunk or individual branches, which keep branching out.

Note that the Subset will not include the Root residue by default.

References root_residue_, and root_residues_.

Referenced by core::select::residue_selector::RandomGlycanFoliageSelector::apply(), and GlycanResidueSelector().

void core::select::residue_selector::GlycanResidueSelector::set_select_from_branch_residues ( utility::vector1< bool root_residues)

Set the residue(s) to select from. These can be the branch points of the glycans or carbohydrate residues from which to select the downstream branch from.

Like the rest of a tree from a particular position. That position could be the trunk or individual branches, which keep branching out.

Note that the Subset will not include the Root residue by default.

References root_residue_, and root_residues_.

Referenced by GlycanResidueSelector().

Member Data Documentation

bool core::select::residue_selector::GlycanResidueSelector::include_root_
private
utility::vector1< std::string > core::select::residue_selector::GlycanResidueSelector::parsed_positions_
private

Referenced by apply(), and parse_my_tag().

std::string core::select::residue_selector::GlycanResidueSelector::ref_pose_name_
private

Referenced by apply(), and parse_my_tag().

core::Size core::select::residue_selector::GlycanResidueSelector::root_residue_
private
utility::vector1< bool > core::select::residue_selector::GlycanResidueSelector::root_residues_
private

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