core::select::residue_selector::BlockSelector Class Reference

selectes a specified continuous block of previously selected residues More...

#include <BlockSelector.hh>

Inheritance diagram for core::select::residue_selector::BlockSelector:

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

Public Member Functions
	BlockSelector ()
	Constructor. More...
	~BlockSelector () 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_block_number (core::Size block_number)
void	set_inverse (bool inverse)
void	set_selector (core::select::residue_selector::ResidueSelectorCOP selector)
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...
utility::vector1< core::Size >	selection_positions (core::pose::Pose const &pose) const
	Calls apply and returns the Rosetta numbering corresponding to the selected residues. 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
core::select::residue_selector::ResidueSelectorCOP	selector_ = nullptr
core::Size	block_number_ = 1
bool	inverse_ = false

Detailed Description

selectes a specified continuous block of previously selected residues

Member Typedef Documentation

ResidueSelectorOP

typedef core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::BlockSelector::ResidueSelectorOP

ResidueSubset

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

Constructor & Destructor Documentation

BlockSelector()

core::select::residue_selector::BlockSelector::BlockSelector

(

)

Constructor.

~BlockSelector()

core::select::residue_selector::BlockSelector::~BlockSelector ( )

override

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

Destructor.

Member Function Documentation

apply()

BlockSelector::ResidueSubset core::select::residue_selector::BlockSelector::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 block_number_, core::select::residue_selector::identify_ss_blocks_vec(), inverse_, selector_, core::pose::Pose::size(), core::pose::Pose::total_residue(), and core::select::residue_selector::TR().

class_name()

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

static

Get the mover class name.

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

clone()

core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::BlockSelector::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.

get_name()

std::string core::select::residue_selector::BlockSelector::get_name ( ) const

overridevirtual

Get the mover class name.

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

References class_name().

parse_my_tag()

void core::select::residue_selector::BlockSelector::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 block_number_, core::select::residue_selector::get_residue_selector(), inverse_, and selector_.

provide_xml_schema()

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

static

Provide XSD information, enabling mechanical validation of input XML.

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

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

set_block_number()

void core::select::residue_selector::BlockSelector::set_block_number

(

core::Size

block_number

)

References block_number_.

set_inverse()

void core::select::residue_selector::BlockSelector::set_inverse

(

bool

inverse

)

References inverse_.

set_selector()

void core::select::residue_selector::BlockSelector::set_selector

(

core::select::residue_selector::ResidueSelectorCOP

selector

)

References selector_.

Member Data Documentation

block_number_

core::Size core::select::residue_selector::BlockSelector::block_number_ = 1

private

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

inverse_

bool core::select::residue_selector::BlockSelector::inverse_ = false

private

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

selector_

core::select::residue_selector::ResidueSelectorCOP core::select::residue_selector::BlockSelector::selector_ = nullptr

private

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

---

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

• src/core/select/residue_selector/BlockSelector.hh
• src/core/select/residue_selector/BlockSelector.cc