Class, much like the OperateOnCertainResidues task operation, to apply a particular residue-level task operation on the residues identified by a ResidueSelector (Or a pre-selected subset). More...

#include <OperateOnResidueSubset.hh>

Inheritance diagram for core::pack::task::operation::OperateOnResidueSubset:

[legend]

Public Types
typedef TaskOperation	parent

typedef utility::tag::TagCOP	TagCOP

typedef pose::Pose	Pose

Public Types inherited from core::pack::task::operation::TaskOperation
typedef utility::tag::TagCOP	TagCOP

typedef basic::datacache::DataMap	DataMap

typedef pose::Pose	Pose

Public Member Functions
	OperateOnResidueSubset ()

	OperateOnResidueSubset (ResLvlTaskOperationCOP, core::select::residue_selector::ResidueSelectorCOP, bool flip_subset=false)

	OperateOnResidueSubset (ResLvlTaskOperationCOP, utility::vector1< bool > const &subset)

	OperateOnResidueSubset (OperateOnResidueSubset const &)

OperateOnResidueSubset &	operator= (OperateOnResidueSubset const &)

	~OperateOnResidueSubset () override

TaskOperationOP	clone () const override
	Create another task operation of the type matching the most-derived version of the class. More...

void	apply (Pose const &, PackerTask &) const override
	Change a packer task in some way. The input pose is the one to which the input task will be later applied. More...

void	op (ResLvlTaskOperationCOP)
	sets the ResLvlTaskOperation that will be applied to residues More...

void	append_op (ResLvlTaskOperationCOP)
	Add a ResLvlTaskOperation to the list of those that will be applied to the selected residues. More...

void	selector (core::select::residue_selector::ResidueSelectorCOP)
	sets the ResidueSelector that will be used to determine which residues to apply the RLTOP to More...

void	subset (utility::vector1< bool > const &subset_residues)
	sets a specific subset that will be operated on instead of a selector itself. More...

void	flip_subset (bool flip)
	Flip the subset on apply. False becomes True, True becomes False. Easier to interact with certain RLTOP. More...

void	parse_tag (TagCOP, DataMap &) override
	Used to parse an xml-like tag to construct the ResLvlTaskOperation and the ResFilter. More...

Public Member Functions inherited from core::pack::task::operation::TaskOperation
	~TaskOperation () override

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	keyname ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
std::list< ResLvlTaskOperationCOP >	ops_

core::select::residue_selector::ResidueSelectorCOP	residue_selector_

utility::vector1< bool >	user_provided_subset_

bool	flip_subset_ = false

Detailed Description

Class, much like the OperateOnCertainResidues task operation, to apply a particular residue-level task operation on the residues identified by a ResidueSelector (Or a pre-selected subset).

Member Typedef Documentation

typedef TaskOperation core::pack::task::operation::OperateOnResidueSubset::parent

typedef pose::Pose core::pack::task::operation::OperateOnResidueSubset::Pose

typedef utility::tag::TagCOP core::pack::task::operation::OperateOnResidueSubset::TagCOP

Constructor & Destructor Documentation

core::pack::task::operation::OperateOnResidueSubset::OperateOnResidueSubset ( )

default

core::pack::task::operation::OperateOnResidueSubset::OperateOnResidueSubset	(	ResLvlTaskOperationCOP	rlto,
		core::select::residue_selector::ResidueSelectorCOP	selector,
		bool	flip_subset = `false`
	)

References ops_.

core::pack::task::operation::OperateOnResidueSubset::OperateOnResidueSubset	(	ResLvlTaskOperationCOP	rlto,
		utility::vector1< bool > const &	subset
	)

References ops_.

core::pack::task::operation::OperateOnResidueSubset::OperateOnResidueSubset ( OperateOnResidueSubset const & src )

core::pack::task::operation::OperateOnResidueSubset::~OperateOnResidueSubset ( )

overridedefault

Member Function Documentation

void core::pack::task::operation::OperateOnResidueSubset::append_op ( ResLvlTaskOperationCOP op_in )

Add a ResLvlTaskOperation to the list of those that will be applied to the selected residues.

References ops_.

void core::pack::task::operation::OperateOnResidueSubset::apply	(	Pose const &	,
		PackerTask &
	)		const

overridevirtual

Change a packer task in some way. The input pose is the one to which the input task will be later applied.

Implements core::pack::task::operation::TaskOperation.

References flip_subset_, core::pack::task::PackerTask::nonconst_residue_task(), op(), ops_, residue_selector_, core::pose::Pose::size(), subset(), core::pack::task::PackerTask::total_residue(), and user_provided_subset_.

TaskOperationOP core::pack::task::operation::OperateOnResidueSubset::clone ( ) const

overridevirtual

Create another task operation of the type matching the most-derived version of the class.

Implements core::pack::task::operation::TaskOperation.

void core::pack::task::operation::OperateOnResidueSubset::flip_subset ( bool flip )

Flip the subset on apply. False becomes True, True becomes False. Easier to interact with certain RLTOP.

References flip_subset_.

std::string core::pack::task::operation::OperateOnResidueSubset::keyname ( )

static

Referenced by core::pack::task::operation::OperateOnResidueSubsetCreator::keyname(), and provide_xml_schema().

void core::pack::task::operation::OperateOnResidueSubset::op ( ResLvlTaskOperationCOP op_in )

sets the ResLvlTaskOperation that will be applied to residues

References ops_.

Referenced by apply().

OperateOnResidueSubset & core::pack::task::operation::OperateOnResidueSubset::operator= ( OperateOnResidueSubset const & )

default

void core::pack::task::operation::OperateOnResidueSubset::parse_tag	(	TagCOP	tag,
		DataMap &	datamap
	)

overridevirtual

Used to parse an xml-like tag to construct the ResLvlTaskOperation and the ResFilter.

tag parsing for factory construction of this class and its children

Example Tag syntax for parser as of October 2013

Reimplemented from core::pack::task::operation::TaskOperation.

References protocols::pack_daemon::error_message, core::select::residue_selector::get_residue_selector(), core::select::residue_selector::ResidueSelectorFactory::has_type(), core::select::residue_selector::ResidueSelectorFactory::new_residue_selector(), ops_, core::pack::task::operation::parse_residue_level_task_operations(), core::select::residue_selector::parse_residue_selector_logic_string(), residue_selector_, selector(), and core::pack::task::operation::TR().

void core::pack::task::operation::OperateOnResidueSubset::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

The XSD says that the residue selector must appear before the RLTO.

References core::pack::task::operation::attributes_for_parse_residue_level_operations(), core::select::residue_selector::attributes_for_parse_residue_selector(), core::select::residue_selector::attributes_for_parse_residue_selector_logic_string(), core::pack::task::operation::complex_type_name_for_task_op(), keyname(), and core::pack::task::operation::ResLvlTaskOperationFactory::res_lvl_task_op_xml_schema_group_name().

Referenced by core::pack::task::operation::OperateOnResidueSubsetCreator::provide_xml_schema().

void core::pack::task::operation::OperateOnResidueSubset::selector ( core::select::residue_selector::ResidueSelectorCOP rs_in )

sets the ResidueSelector that will be used to determine which residues to apply the RLTOP to

References residue_selector_.

Referenced by parse_tag().

void core::pack::task::operation::OperateOnResidueSubset::subset ( utility::vector1< bool > const & subset_residues )

sets a specific subset that will be operated on instead of a selector itself.

References user_provided_subset_.

Referenced by apply().

Member Data Documentation

bool core::pack::task::operation::OperateOnResidueSubset::flip_subset_ = false

private

Referenced by apply(), and flip_subset().

std::list< ResLvlTaskOperationCOP > core::pack::task::operation::OperateOnResidueSubset::ops_

private

Referenced by append_op(), apply(), op(), OperateOnResidueSubset(), and parse_tag().

core::select::residue_selector::ResidueSelectorCOP core::pack::task::operation::OperateOnResidueSubset::residue_selector_

private

Referenced by apply(), parse_tag(), and selector().

utility::vector1< bool > core::pack::task::operation::OperateOnResidueSubset::user_provided_subset_

private

Referenced by apply(), and subset().

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

src/core/pack/task/operation/OperateOnResidueSubset.hh
src/core/pack/task/operation/OperateOnResidueSubset.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation