core::select::residue_selector::ReturnResidueSubsetSelector Class Reference

A simple selector that returns the set subset. This is to enable simplification of code-based interfaces to residue selectors, so that one may accept only selectors, but using this selector, we can set subsets. More...

#include <ReturnResidueSubsetSelector.hh>

Inheritance diagram for core::select::residue_selector::ReturnResidueSubsetSelector:

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

Public Member Functions
	ReturnResidueSubsetSelector ()
	Constructor. More...
	ReturnResidueSubsetSelector (ResidueSubset const &subset)
	~ReturnResidueSubsetSelector () override
	Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs) More...
ResidueSelectorOP	clone () const override
	Clone operator. More...
void	set_residue_subset (ResidueSubset const &subset)
	Set the ResidueSubset, which will be returned at apply-time. 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...
virtual	~ResidueSelector ()
	Destructor. 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
ResidueSubset	subset_

Detailed Description

A simple selector that returns the set subset. This is to enable simplification of code-based interfaces to residue selectors, so that one may accept only selectors, but using this selector, we can set subsets.

This greatly reduces the c++ interface complexity and private variable - complexity arising from accepting BOTH ResidueSubsets and ResidueSelectors (Which I'm terribly sick of doing at this point).

Member Typedef Documentation

typedef core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::ReturnResidueSubsetSelector::ResidueSelectorOP

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

Constructor & Destructor Documentation

core::select::residue_selector::ReturnResidueSubsetSelector::ReturnResidueSubsetSelector

(

)

Constructor.

Referenced by clone().

core::select::residue_selector::ReturnResidueSubsetSelector::ReturnResidueSubsetSelector

(

ResidueSubset const &

subset

)

core::select::residue_selector::ReturnResidueSubsetSelector::~ReturnResidueSubsetSelector ( )

override

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

Destructor.

Member Function Documentation

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

overridevirtual

"Apply" function.

Return the set subset.

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 core::pose::Pose::size(), and subset_.

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

static

Get the mover class name.

Referenced by get_name().

ReturnResidueSubsetSelector::ResidueSelectorOP core::select::residue_selector::ReturnResidueSubsetSelector::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.

References ReturnResidueSubsetSelector().

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

overridevirtual

Get the mover class name.

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

References class_name().

void core::select::residue_selector::ReturnResidueSubsetSelector::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.

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

static

Provide XSD information, enabling mechanical validation of input XML.

void core::select::residue_selector::ReturnResidueSubsetSelector::set_residue_subset

(

ResidueSubset const &

subset

)

Set the ResidueSubset, which will be returned at apply-time.

References subset_.

Member Data Documentation

ResidueSubset core::select::residue_selector::ReturnResidueSubsetSelector::subset_

private

Referenced by apply(), and set_residue_subset().

---

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

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