core::select::jump_selector::OrJumpSelector Class Reference

The OrJumpSelector combines the output of multiple JumpSelectors using OR logic, i.e., jumps selected by ANY of the contained JumpSelectors will be selected. JumpSelectors can be pulled in from a DataMap, from subtags (for JumpSelectors known to the JumpSelectorFactory) or programmatically through add_jump_selector. More...

#include <OrJumpSelector.hh>

Inheritance diagram for core::select::jump_selector::OrJumpSelector:

Public Member Functions
	OrJumpSelector ()
	OrJumpSelector (OrJumpSelector const &src)
	Copy constructor. More...
	OrJumpSelector (JumpSelectorCOP selector1, JumpSelectorCOP selector2)
	~OrJumpSelector () override
JumpSelectorOP	clone () const override
	Clone operator. More...
JumpSubset	apply (core::pose::Pose const &pose) const override
	Return a JumpSubset indicating a selection of Jumps from the input Pose; the JumpSubset is an array of booleans of length pose.num_jump() where a value of "true" for position i indicates that jump i is a part of the selected subset – and a value of "false" would indicate that it is not. More...
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_jump_selector (JumpSelectorCOP selector)
	adds a JumpSelector More...
Size	num_selectors () const
void	apply_or_to_subset (JumpSubset const &newSubset, JumpSubset &existingSubset) const
	applies newSubset to existingSubset and thereby modifies the latter More...
Public Member Functions inherited from core::select::jump_selector::JumpSelector
	JumpSelector ()
	Constructor. More...
	~JumpSelector () override
	Destructor. More...
utility::vector1< core::Size >	selection_jumps (core::pose::Pose const &pose) const
	Calls apply and returns a vector of the selected jump ids. More...

Static Public Member Functions
static std::string	class_name ()
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
std::list< JumpSelectorCOP >	selectors_

Detailed Description

The OrJumpSelector combines the output of multiple JumpSelectors using OR logic, i.e., jumps selected by ANY of the contained JumpSelectors will be selected. JumpSelectors can be pulled in from a DataMap, from subtags (for JumpSelectors known to the JumpSelectorFactory) or programmatically through add_jump_selector.

Constructor & Destructor Documentation

OrJumpSelector() [1/3]

core::select::jump_selector::OrJumpSelector::OrJumpSelector ( )

default

OrJumpSelector() [2/3]

core::select::jump_selector::OrJumpSelector::OrJumpSelector

(

OrJumpSelector const &

src

)

Copy constructor.

OrJumpSelector() [3/3]

core::select::jump_selector::OrJumpSelector::OrJumpSelector	(	JumpSelectorCOP	selector1,
		JumpSelectorCOP	selector2
	)

References add_jump_selector().

~OrJumpSelector()

core::select::jump_selector::OrJumpSelector::~OrJumpSelector ( )

overridedefault

Member Function Documentation

add_jump_selector()

void core::select::jump_selector::OrJumpSelector::add_jump_selector

(

JumpSelectorCOP

selector

)

adds a JumpSelector

References selectors_.

Referenced by OrJumpSelector(), and parse_my_tag().

apply()

JumpSubset core::select::jump_selector::OrJumpSelector::apply ( core::pose::Pose const &  pose ) const

overridevirtual

Return a JumpSubset indicating a selection of Jumps from the input Pose; the JumpSubset is an array of booleans of length pose.num_jump() where a value of "true" for position i indicates that jump i is a part of the selected subset – and a value of "false" would indicate that it is not.

Implements core::select::jump_selector::JumpSelector.

References apply_or_to_subset(), core::pose::Pose::num_jump(), num_selectors(), and selectors_.

apply_or_to_subset()

void core::select::jump_selector::OrJumpSelector::apply_or_to_subset	(	JumpSubset const &	newSubset,
		JumpSubset &	existingSubset
	)		const

applies newSubset to existingSubset and thereby modifies the latter

Referenced by apply().

class_name()

std::string core::select::jump_selector::OrJumpSelector::class_name ( )

static

Referenced by get_name(), core::select::jump_selector::OrJumpSelectorCreator::keyname(), and provide_xml_schema().

clone()

JumpSelectorOP core::select::jump_selector::OrJumpSelector::clone ( ) const

overridevirtual

Clone operator.

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

Implements core::select::jump_selector::JumpSelector.

get_name()

std::string core::select::jump_selector::OrJumpSelector::get_name ( ) const

overridevirtual

Implements core::select::jump_selector::JumpSelector.

References class_name().

num_selectors()

Size core::select::jump_selector::OrJumpSelector::num_selectors

(

)

const

References selectors_.

Referenced by apply().

parse_my_tag()

void core::select::jump_selector::OrJumpSelector::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::jump_selector::JumpSelector.

References add_jump_selector().

provide_xml_schema()

void core::select::jump_selector::OrJumpSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References class_name(), and core::select::jump_selector::xsd_type_definition_w_attributes_and_optional_subselectors().

Referenced by core::select::jump_selector::OrJumpSelectorCreator::provide_xml_schema().

Member Data Documentation

selectors_

std::list< JumpSelectorCOP > core::select::jump_selector::OrJumpSelector::selectors_

private

Referenced by add_jump_selector(), apply(), and num_selectors().

---

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

• src/core/select/jump_selector/OrJumpSelector.hh
• src/core/select/jump_selector/OrJumpSelector.cc