#include <OperateOnCertainResidues.hh>

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

Public Types
typedef TaskOperation	parent

typedef utility::tag::TagCOP	TagCOP

typedef pose::Pose	Pose

typedef utility::vector1< Size >	ResidueIndices

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

	OperateOnCertainResidues (ResLvlTaskOperationOP, ResFilterOP)

	OperateOnCertainResidues (OperateOnCertainResidues const &)

OperateOnCertainResidues &	operator= (OperateOnCertainResidues const &)

	~OperateOnCertainResidues () 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	residue_indices (ResidueIndices const &)
	supports direct limitation of residues to be affected, without the need for a filter More...

ResidueIndices &	residue_indices ()

ResidueIndices const &	residue_indices () const

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

void	filter (ResFilterCOP)
	sets an optional filter that is applied to each individual residue 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
ResidueIndices	residue_indices_

ResLvlTaskOperationOP	op_

ResFilterOP	filter_

Member Typedef Documentation

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

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

typedef utility::vector1< Size > core::pack::task::operation::OperateOnCertainResidues::ResidueIndices

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

Constructor & Destructor Documentation

core::pack::task::operation::OperateOnCertainResidues::OperateOnCertainResidues ( )

core::pack::task::operation::OperateOnCertainResidues::OperateOnCertainResidues	(	ResLvlTaskOperationOP	rlto,
		ResFilterOP	filter
	)

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

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

overridedefault

Member Function Documentation

void core::pack::task::operation::OperateOnCertainResidues::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 core::sequence::end, filter_, core::pack::task::PackerTask::nonconst_residue_task(), op_, residue_indices_, core::pose::Pose::size(), and core::pack::task::PackerTask::total_residue().

Referenced by protocols::task_operations::SelectResiduesWithinChainOperation::apply(), protocols::task_operations::RestrictIdentitiesAtAlignedPositionsOperation::apply(), protocols::task_operations::RestrictToAlignedSegmentsOperation::apply(), and protocols::task_operations::ProteinInterfaceDesignOperation::apply().

TaskOperationOP core::pack::task::operation::OperateOnCertainResidues::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::OperateOnCertainResidues::filter ( ResFilterCOP filter_in )

sets an optional filter that is applied to each individual residue

References filter_.

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

static

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

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

sets the ResLvlTaskOperation that will be applied to residues

References op_.

Referenced by protocols::task_operations::SelectResiduesWithinChainOperation::apply(), protocols::task_operations::RestrictIdentitiesAtAlignedPositionsOperation::apply(), protocols::task_operations::RestrictToAlignedSegmentsOperation::apply(), protocols::task_operations::DesignAroundOperation::apply(), and protocols::task_operations::ProteinInterfaceDesignOperation::apply().

OperateOnCertainResidues & core::pack::task::operation::OperateOnCertainResidues::operator= ( OperateOnCertainResidues const & src )

References filter_, op_, residue_indices(), and residue_indices_.

void core::pack::task::operation::OperateOnCertainResidues::parse_tag	(	TagCOP	tag,
		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 Summer 2009

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

References filter_, core::pack::task::operation::ResFilterFactory::has_type(), core::pack::task::operation::ResFilterFactory::newResFilter(), op_, and core::pack::task::operation::TR().

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

static

References core::pack::task::operation::complex_type_name_for_task_op(), keyname(), core::pack::task::operation::ResFilterFactory::res_filter_xml_schema_group_name(), and core::pack::task::operation::ResLvlTaskOperationFactory::res_lvl_task_op_xml_schema_group_name().

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

void core::pack::task::operation::OperateOnCertainResidues::residue_indices ( ResidueIndices const & )

supports direct limitation of residues to be affected, without the need for a filter

Referenced by protocols::task_operations::SelectResiduesWithinChainOperation::apply(), protocols::task_operations::RestrictIdentitiesAtAlignedPositionsOperation::apply(), protocols::task_operations::RestrictToAlignedSegmentsOperation::apply(), protocols::task_operations::ProteinInterfaceDesignOperation::apply(), and operator=().

ResidueIndices& core::pack::task::operation::OperateOnCertainResidues::residue_indices ( )

inline

References residue_indices_.

ResidueIndices const& core::pack::task::operation::OperateOnCertainResidues::residue_indices ( ) const

inline

References residue_indices_.

Member Data Documentation

ResFilterOP core::pack::task::operation::OperateOnCertainResidues::filter_

private

Referenced by apply(), filter(), operator=(), and parse_tag().

ResLvlTaskOperationOP core::pack::task::operation::OperateOnCertainResidues::op_

private

Referenced by apply(), op(), operator=(), and parse_tag().

ResidueIndices core::pack::task::operation::OperateOnCertainResidues::residue_indices_

private

Referenced by apply(), operator=(), and residue_indices().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation