A residue selector that selects based on set residue properties. More...

#include <ResiduePropertySelector.hh>

Inheritance diagram for core::select::residue_selector::ResiduePropertySelector:

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

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

Public Member Functions
	ResiduePropertySelector ()
	Defualt Constructor. More...

	ResiduePropertySelector (core::chemical::ResidueProperty property)
	Constructor setting a single property for selection. More...

	ResiduePropertySelector (utility::vector1< chemical::ResidueProperty > properties)
	Constructor setting a list of properties for selection. More...

	~ResiduePropertySelector () 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_property (core::chemical::ResidueProperty property)
	Set a single property for selection. More...

void	add_property (core::chemical::ResidueProperty property)
	Add a property to the list for selection. More...

void	set_properties (utility::vector1< core::chemical::ResidueProperty > properties)
	Set a list of properties for selection. More...

void	set_selection_logic (basic_selection_logic logic)
	Set the logic for multiple sets of properties Default is AND logic. 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
utility::vector1 < core::chemical::ResidueProperty >	properties_

basic_selection_logic	logic_ = and_logic

Detailed Description

A residue selector that selects based on set residue properties.

Default is to use AND logic for multiple properties. This can be changed via set_selection_logic.

Member Typedef Documentation

typedef core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::ResiduePropertySelector::ResidueSelectorOP

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

Constructor & Destructor Documentation

core::select::residue_selector::ResiduePropertySelector::ResiduePropertySelector ( )

Defualt Constructor.

Constructor.

core::select::residue_selector::ResiduePropertySelector::ResiduePropertySelector ( core::chemical::ResidueProperty property )

Constructor setting a single property for selection.

References set_property().

core::select::residue_selector::ResiduePropertySelector::ResiduePropertySelector ( utility::vector1< chemical::ResidueProperty > properties )

Constructor setting a list of properties for selection.

References set_properties().

core::select::residue_selector::ResiduePropertySelector::~ResiduePropertySelector ( )

override

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

Destructor.

Member Function Documentation

void core::select::residue_selector::ResiduePropertySelector::add_property ( core::chemical::ResidueProperty property )

Add a property to the list for selection.

References properties_.

Referenced by parse_my_tag().

ResiduePropertySelector::ResidueSubset core::select::residue_selector::ResiduePropertySelector::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 core::select::residue_selector::and_logic, core::chemical::ResidueProperties::has_property(), logic_, core::select::residue_selector::or_logic, core::chemical::ResidueTypeBase::properties(), properties_, core::pose::Pose::residue_type(), and core::pose::Pose::size().

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

static

Get the mover class name.

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

core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::ResiduePropertySelector::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::ResiduePropertySelector::get_name ( ) const

overridevirtual

Get the mover class name.

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

References class_name().

void core::select::residue_selector::ResiduePropertySelector::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 add_property(), core::chemical::ResidueProperties::get_property_from_string(), core::select::residue_selector::logic_map(), core::chemical::NO_PROPERTY, update_ResidueType_enum_files::properties, properties_, and set_selection_logic().

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

static

Provide XSD information, enabling mechanical validation of input XML.

References class_name(), core::chemical::ResidueProperties::get_string_from_property(), core::select::residue_selector::logic_map(), core::chemical::N_PROPERTIES, core::id::to_string(), and core::select::residue_selector::xsd_type_definition_w_attributes().

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

void core::select::residue_selector::ResiduePropertySelector::set_properties ( utility::vector1< core::chemical::ResidueProperty > properties )

Set a list of properties for selection.

References update_ResidueType_enum_files::properties, and properties_.

Referenced by ResiduePropertySelector().

void core::select::residue_selector::ResiduePropertySelector::set_property ( core::chemical::ResidueProperty property )

Set a single property for selection.

References properties_.

Referenced by ResiduePropertySelector().

void core::select::residue_selector::ResiduePropertySelector::set_selection_logic ( basic_selection_logic logic )

Set the logic for multiple sets of properties Default is AND logic.

References logic_.

Referenced by parse_my_tag().

Member Data Documentation

basic_selection_logic core::select::residue_selector::ResiduePropertySelector::logic_ = and_logic

private

Referenced by apply(), and set_selection_logic().

utility::vector1< core::chemical::ResidueProperty > core::select::residue_selector::ResiduePropertySelector::properties_

private

Referenced by add_property(), apply(), parse_my_tag(), set_properties(), and set_property().

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

src/core/select/residue_selector/ResiduePropertySelector.hh
src/core/select/residue_selector/ResiduePropertySelector.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