Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
core::select::jump_selector::AndJumpSelector Class Reference

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

#include <AndJumpSelector.hh>

Inheritance diagram for core::select::jump_selector::AndJumpSelector:
Inheritance graph
[legend]

Public Member Functions

 AndJumpSelector ()
 
 AndJumpSelector (AndJumpSelector const &src)
 Copy constructor. More...
 
JumpSelectorOP clone () const override
 Clone operator. More...
 
 AndJumpSelector (JumpSelectorCOP selector1)
 
 AndJumpSelector (JumpSelectorCOP selector1, JumpSelectorCOP selector2)
 
 ~AndJumpSelector () override
 
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_and_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...
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Attributes

std::list< JumpSelectorCOPselectors_
 

Detailed Description

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

Constructor & Destructor Documentation

core::select::jump_selector::AndJumpSelector::AndJumpSelector ( )
default
core::select::jump_selector::AndJumpSelector::AndJumpSelector ( AndJumpSelector const &  src)

Copy constructor.

core::select::jump_selector::AndJumpSelector::AndJumpSelector ( JumpSelectorCOP  selector1)

References add_jump_selector().

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

References add_jump_selector().

core::select::jump_selector::AndJumpSelector::~AndJumpSelector ( )
overridedefault

Member Function Documentation

void core::select::jump_selector::AndJumpSelector::add_jump_selector ( JumpSelectorCOP  selector)

adds a JumpSelector

References selectors_.

Referenced by AndJumpSelector(), and parse_my_tag().

JumpSubset core::select::jump_selector::AndJumpSelector::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_and_to_subset(), core::pose::Pose::num_jump(), num_selectors(), and selectors_.

void core::select::jump_selector::AndJumpSelector::apply_and_to_subset ( JumpSubset const &  newSubset,
JumpSubset existingSubset 
) const

applies newSubset to existingSubset and thereby modifies the latter

Referenced by apply().

std::string core::select::jump_selector::AndJumpSelector::class_name ( )
static
JumpSelectorOP core::select::jump_selector::AndJumpSelector::clone ( ) const
overridevirtual

Clone operator.

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

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

std::string core::select::jump_selector::AndJumpSelector::get_name ( ) const
overridevirtual
Size core::select::jump_selector::AndJumpSelector::num_selectors ( ) const

References selectors_.

Referenced by apply().

void core::select::jump_selector::AndJumpSelector::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().

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

Member Data Documentation

std::list< JumpSelectorCOP > core::select::jump_selector::AndJumpSelector::selectors_
private

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