The AndResidueSelector combines the output of multiple ResidueSelectors using AND logic, i.e., only residues selected by ALL contained ResidueSelectors will be selected. ResidueSelecters can be pulled in from a DataMap, from subtags (for ResidueSelectors known to the ResidueSelectorFactory) or programmatically through add_residue_selector. More...

#include <AndResidueSelector.hh>

Inheritance diagram for core::select::residue_selector::AndResidueSelector:

[legend]

Public Member Functions
	AndResidueSelector ()

	AndResidueSelector (AndResidueSelector const &src)
	Copy constructor. More...

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

	AndResidueSelector (ResidueSelectorCOP selector1)

	AndResidueSelector (ResidueSelectorCOP selector1, ResidueSelectorCOP selector2)

	~AndResidueSelector () override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &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	add_residue_selector (ResidueSelectorCOP selector)
	adds a ResidueSelector More...

Size	num_selectors () const
	Get the number of contained selectors. More...

void	clear ()
	Clear the contained selectors. 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	apply_and_to_subset (ResidueSubset const &newSubset, ResidueSubset &existingSubset) const
	applies newSubset to existingSubset and thereby modifies the latter More...

void	provide_citation_info (basic::citation_manager::CitationCollectionList &) const override
	Provide the citation. 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...

Static Public Member Functions
static std::string	class_name ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
std::list< ResidueSelectorCOP >	selectors_

Detailed Description

The AndResidueSelector combines the output of multiple ResidueSelectors using AND logic, i.e., only residues selected by ALL contained ResidueSelectors will be selected. ResidueSelecters can be pulled in from a DataMap, from subtags (for ResidueSelectors known to the ResidueSelectorFactory) or programmatically through add_residue_selector.

Constructor & Destructor Documentation

◆ AndResidueSelector() [1/4]

core::select::residue_selector::AndResidueSelector::AndResidueSelector ( )

default

◆ AndResidueSelector() [2/4]

core::select::residue_selector::AndResidueSelector::AndResidueSelector ( AndResidueSelector const & src )

Copy constructor.

◆ AndResidueSelector() [3/4]

core::select::residue_selector::AndResidueSelector::AndResidueSelector ( ResidueSelectorCOP selector1 )

References add_residue_selector().

◆ AndResidueSelector() [4/4]

core::select::residue_selector::AndResidueSelector::AndResidueSelector	(	ResidueSelectorCOP	selector1,
		ResidueSelectorCOP	selector2
	)

References add_residue_selector().

◆ ~AndResidueSelector()

core::select::residue_selector::AndResidueSelector::~AndResidueSelector ( )

overridedefault

Member Function Documentation

◆ add_residue_selector()

void core::select::residue_selector::AndResidueSelector::add_residue_selector ( ResidueSelectorCOP selector )

adds a ResidueSelector

References selectors_.

Referenced by AndResidueSelector(), and parse_my_tag().

◆ apply()

ResidueSubset core::select::residue_selector::AndResidueSelector::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 apply_and_to_subset(), num_selectors(), selectors_, and core::pose::Pose::size().

◆ apply_and_to_subset()

void core::select::residue_selector::AndResidueSelector::apply_and_to_subset	(	ResidueSubset const &	newSubset,
		ResidueSubset &	existingSubset
	)		const

applies newSubset to existingSubset and thereby modifies the latter

Referenced by apply().

◆ class_name()

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

static

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

◆ clear()

void core::select::residue_selector::AndResidueSelector::clear ( )

Clear the contained selectors.

References selectors_.

◆ clone()

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

overridevirtual

Clone operator.

Copy this object and return an owning pointer to the new object.

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

◆ get_name()

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

overridevirtual

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

References class_name().

◆ num_selectors()

Size core::select::residue_selector::AndResidueSelector::num_selectors ( ) const

Get the number of contained selectors.

References selectors_.

Referenced by apply().

◆ parse_my_tag()

void core::select::residue_selector::AndResidueSelector::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 add_residue_selector(), and core::select::residue_selector::get_residue_selector().

◆ provide_citation_info()

void core::select::residue_selector::AndResidueSelector::provide_citation_info ( basic::citation_manager::CitationCollectionList & citations ) const

overridevirtual

Provide the citation.

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

References selectors_.

◆ provide_xml_schema()

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

static

References core::select::residue_selector::attributes_for_parse_residue_selector(), class_name(), and core::select::residue_selector::xsd_type_definition_w_attributes_and_optional_subselectors().

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

Member Data Documentation

◆ selectors_

std::list< ResidueSelectorCOP > core::select::residue_selector::AndResidueSelector::selectors_

private

Referenced by add_residue_selector(), apply(), clear(), num_selectors(), and provide_citation_info().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AndResidueSelector() [1/4]

◆ AndResidueSelector() [2/4]

◆ AndResidueSelector() [3/4]

◆ AndResidueSelector() [4/4]

◆ ~AndResidueSelector()

Member Function Documentation

◆ add_residue_selector()

◆ apply()

◆ apply_and_to_subset()

◆ class_name()

◆ clear()

◆ clone()

◆ get_name()

◆ num_selectors()

◆ parse_my_tag()

◆ provide_citation_info()

◆ provide_xml_schema()

Member Data Documentation

◆ selectors_