core::select::jump_selector::JumpForResidue Class Reference

#include <JumpForResidue.hh>

Inheritance diagram for core::select::jump_selector::JumpForResidue:

Public Member Functions
	JumpForResidue ()=default
	~JumpForResidue () override=default
	JumpForResidue (JumpForResidue const &)=default
JumpForResidue &	operator= (JumpForResidue const &)=default
	JumpForResidue (JumpForResidue &&)=default
JumpForResidue &	operator= (JumpForResidue &&)=default
	JumpForResidue (core::Size const resid)
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 &) override
	Initialize any data members of this instance from an input tag and a DataMap object. More...
std::string	get_name () const override
void	set_residue_selector (core::select::residue_selector::ResidueSelectorCOP selector)
	We will select the jumps that build the residues selected by this residue selector. More...
void	set_allow_multiple_results (bool const setting)
	If false, we will assert that every residue passed in is built by the same jump. 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
core::select::residue_selector::ResidueSelectorCOP	selector_ = nullptr
bool	allow_multiple_results_ = false

Constructor & Destructor Documentation

JumpForResidue() [1/4]

core::select::jump_selector::JumpForResidue::JumpForResidue ( )

default

~JumpForResidue()

core::select::jump_selector::JumpForResidue::~JumpForResidue ( )

overridedefault

JumpForResidue() [2/4]

core::select::jump_selector::JumpForResidue::JumpForResidue ( JumpForResidue const &  )

default

JumpForResidue() [3/4]

core::select::jump_selector::JumpForResidue::JumpForResidue ( JumpForResidue &&  )

default

JumpForResidue() [4/4]

core::select::jump_selector::JumpForResidue::JumpForResidue

(

core::Size const

resid

)

Member Function Documentation

apply()

JumpSubset core::select::jump_selector::JumpForResidue::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 allow_multiple_results_, core::pose::Pose::fold_tree(), core::pose::Pose::num_jump(), core::select::resids(), core::select::residue_selector::selection_positions(), and selector_.

class_name()

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

static

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

clone()

JumpSelectorOP core::select::jump_selector::JumpForResidue::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::JumpForResidue::get_name ( ) const

overridevirtual

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

References class_name().

operator=() [1/2]

JumpForResidue& core::select::jump_selector::JumpForResidue::operator= ( JumpForResidue &&  )

default

operator=() [2/2]

JumpForResidue& core::select::jump_selector::JumpForResidue::operator= ( JumpForResidue const &  )

default

parse_my_tag()

void core::select::jump_selector::JumpForResidue::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 core::select::residue_selector::get_residue_selector(), selector_, and set_allow_multiple_results().

provide_xml_schema()

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

static

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

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

set_allow_multiple_results()

void core::select::jump_selector::JumpForResidue::set_allow_multiple_results ( bool const  setting )

inline

If false, we will assert that every residue passed in is built by the same jump.

References allow_multiple_results_.

Referenced by parse_my_tag().

set_residue_selector()

void core::select::jump_selector::JumpForResidue::set_residue_selector ( core::select::residue_selector::ResidueSelectorCOP  selector )

inline

We will select the jumps that build the residues selected by this residue selector.

References selector_.

Member Data Documentation

allow_multiple_results_

bool core::select::jump_selector::JumpForResidue::allow_multiple_results_ = false

private

Referenced by apply(), and set_allow_multiple_results().

selector_

core::select::residue_selector::ResidueSelectorCOP core::select::jump_selector::JumpForResidue::selector_ = nullptr

private

Referenced by apply(), parse_my_tag(), and set_residue_selector().

---

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

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