A selector for choosing glycan residues based on their layer - as measured by the residue distance to the start of the glycan tree. If no layer is set, will select all glycan residues. More...

#include <GlycanLayerSelector.hh>

Inheritance diagram for core::select::residue_selector::GlycanLayerSelector:

[legend]

Public Types
typedef core::select::residue_selector::ResidueSelectorOP	ResidueSelectorOP

typedef core::select::residue_selector::ResidueSubset	ResidueSubset

Public Member Functions
	GlycanLayerSelector ()
	Constructor. More...

	~GlycanLayerSelector () override
	Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs) More...

ResidueSelectorOP	clone () const override
	Clone operator. More...

ResidueSubset	apply (core::pose::Pose const &pose) const override
	"Apply" function. More...

void	set_layer (core::Size start, core::Size end)
	Set the layer we will be returning. More...

void	set_layer_as_greater_than_or_equal_to (core::Size start)
	Set the layer as all residues greater than or equal to this number (such as the end of the tree) More...

void	set_layer_as_less_than_or_equal_to (core::Size end)
	Set the layer as all residue less or equal to this number (the beginning of the tree). 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 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 ()
	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
core::Size	start_ = 0

core::Size	end_ = 0

core::Size	start_from_as_layer_ = 0

core::Size	end_for_layer_ = 0

bool	range_set_ = false

Detailed Description

A selector for choosing glycan residues based on their layer - as measured by the residue distance to the start of the glycan tree. If no layer is set, will select all glycan residues.

Member Typedef Documentation

typedef core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::GlycanLayerSelector::ResidueSelectorOP

typedef core::select::residue_selector::ResidueSubset core::select::residue_selector::GlycanLayerSelector::ResidueSubset

Constructor & Destructor Documentation

core::select::residue_selector::GlycanLayerSelector::GlycanLayerSelector ( )

Constructor.

core::select::residue_selector::GlycanLayerSelector::~GlycanLayerSelector ( )

overridedefault

Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs)

Destructor.

Member Function Documentation

GlycanLayerSelector::ResidueSubset core::select::residue_selector::GlycanLayerSelector::apply ( core::pose::Pose const & pose ) const

overridevirtual

"Apply" function.

Given the pose, generate a vector of bools with entries for every residue in the pose indicating whether each residue is selected ("true") or not ("false").

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

References end_, end_for_layer_, core::pose::Pose::glycan_tree_set(), core::chemical::ResidueType::is_carbohydrate(), range_set_, core::pose::Pose::residue_type(), start_, start_from_as_layer_, core::pose::Pose::total_residue(), and core::select::residue_selector::TR().

Referenced by protocols::carbohydrates::get_total_rounds_for_overlap_one_layer_two().

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

static

Get the mover class name.

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

GlycanLayerSelector::ResidueSelectorOP core::select::residue_selector::GlycanLayerSelector::clone ( ) const

overridevirtual

Clone operator.

Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs)

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

Clone function.

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::GlycanLayerSelector::get_name ( ) const

overridevirtual

Get the mover class name.

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

References class_name().

void core::select::residue_selector::GlycanLayerSelector::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 end_, end_for_layer_, range_set_, start_, and start_from_as_layer_.

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

static

Provide XSD information, enabling mechanical validation of input XML.

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

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

void core::select::residue_selector::GlycanLayerSelector::set_layer	(	core::Size	start,
		core::Size	end
	)

Set the layer we will be returning.

References core::sequence::end, end_, end_for_layer_, range_set_, protocols::loops::start, start_, and start_from_as_layer_.

Referenced by protocols::carbohydrates::get_total_rounds_for_overlap_one_layer_two().

void core::select::residue_selector::GlycanLayerSelector::set_layer_as_greater_than_or_equal_to ( core::Size start )

Set the layer as all residues greater than or equal to this number (such as the end of the tree)

References end_, end_for_layer_, range_set_, protocols::loops::start, start_, and start_from_as_layer_.

void core::select::residue_selector::GlycanLayerSelector::set_layer_as_less_than_or_equal_to ( core::Size end )

Set the layer as all residue less or equal to this number (the beginning of the tree).

References core::sequence::end, end_, end_for_layer_, range_set_, and start_.

Member Data Documentation

core::Size core::select::residue_selector::GlycanLayerSelector::end_ = 0

private

Referenced by apply(), parse_my_tag(), set_layer(), set_layer_as_greater_than_or_equal_to(), and set_layer_as_less_than_or_equal_to().

core::Size core::select::residue_selector::GlycanLayerSelector::end_for_layer_ = 0

private

Referenced by apply(), parse_my_tag(), set_layer(), set_layer_as_greater_than_or_equal_to(), and set_layer_as_less_than_or_equal_to().

bool core::select::residue_selector::GlycanLayerSelector::range_set_ = false

private

Referenced by apply(), parse_my_tag(), set_layer(), set_layer_as_greater_than_or_equal_to(), and set_layer_as_less_than_or_equal_to().

core::Size core::select::residue_selector::GlycanLayerSelector::start_ = 0

private

Referenced by apply(), parse_my_tag(), set_layer(), set_layer_as_greater_than_or_equal_to(), and set_layer_as_less_than_or_equal_to().

core::Size core::select::residue_selector::GlycanLayerSelector::start_from_as_layer_ = 0

private

Referenced by apply(), parse_my_tag(), set_layer(), and set_layer_as_greater_than_or_equal_to().

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

src/core/select/residue_selector/GlycanLayerSelector.hh
src/core/select/residue_selector/GlycanLayerSelector.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation