core::select::jump_selector::JumpIndexSelector Class Reference

The JumpIndexSelector returns a JumpSubset, i.e. a utility::vector1< bool > containing 'true' for jump positions which lie upstream of a given jump in the FoldTree. The jump is specified by its integer index. More...

#include <JumpIndexSelector.hh>

Inheritance diagram for core::select::jump_selector::JumpIndexSelector:

Public Member Functions
	JumpIndexSelector ()
	JumpIndexSelector (JumpIndexSelector const &src)
	Copy constructor. More...
JumpSelectorOP	clone () const override
	Clone operator. More...
	JumpIndexSelector (int jump, bool soft_error=false)
	~JumpIndexSelector () 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 &) override
	Initialize any data members of this instance from an input tag and a DataMap object. More...
std::string	get_name () const override
int	jump () const
void	jump (int jump)
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
int	jump_ = 0
bool	soft_error_ = false
	If soft_error is true, ignore jumps that are outside the Pose. More...

Detailed Description

The JumpIndexSelector returns a JumpSubset, i.e. a utility::vector1< bool > containing 'true' for jump positions which lie upstream of a given jump in the FoldTree. The jump is specified by its integer index.

Constructor & Destructor Documentation

JumpIndexSelector() [1/3]

core::select::jump_selector::JumpIndexSelector::JumpIndexSelector ( )

default

JumpIndexSelector() [2/3]

core::select::jump_selector::JumpIndexSelector::JumpIndexSelector ( JumpIndexSelector const &  src )

default

Copy constructor.

JumpIndexSelector() [3/3]

core::select::jump_selector::JumpIndexSelector::JumpIndexSelector	(	int	jump,
		bool	soft_error = false
	)

If soft_error is true, ignore jumps that are outside the Pose.

~JumpIndexSelector()

core::select::jump_selector::JumpIndexSelector::~JumpIndexSelector ( )

overridedefault

Member Function Documentation

apply()

JumpSubset core::select::jump_selector::JumpIndexSelector::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 core::pose::Pose::fold_tree(), jump_, core::kinematics::FoldTree::num_jump(), soft_error_, and core::select::jump_selector::TR().

class_name()

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

static

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

clone()

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

overridevirtual

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

References class_name().

jump() [1/2]

int core::select::jump_selector::JumpIndexSelector::jump

(

)

const

References jump_.

Referenced by jump(), and parse_my_tag().

jump() [2/2]

void core::select::jump_selector::JumpIndexSelector::jump

(

int

jump

)

References jump(), and jump_.

parse_my_tag()

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

provide_xml_schema()

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

static

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

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

Member Data Documentation

jump_

int core::select::jump_selector::JumpIndexSelector::jump_ = 0

private

Referenced by apply(), and jump().

soft_error_

bool core::select::jump_selector::JumpIndexSelector::soft_error_ = false

private

If soft_error is true, ignore jumps that are outside the Pose.

Referenced by apply().

---

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

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