#include <RestrictOperationsBase.hh>

Inheritance diagram for protocols::toolbox::task_operations::RestrictOperationsBase:

Collaboration diagram for protocols::toolbox::task_operations::RestrictOperationsBase:

Public Types
typedef core::pack::task::operation::TaskOperation	TaskOperation

typedef core::pack::task::operation::TaskOperationOP	TaskOperationOP

typedef TaskOperation	parent

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

typedef pose::Pose	Pose

Public Member Functions
	RestrictOperationsBase ()

virtual	~RestrictOperationsBase ()

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

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

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

virtual void	parse_tag (TagPtr)
	Used to parse an xml-like tag to load parameters and properties. More...

virtual void	parse_def (utility::lua::LuaObject const &def)

Protected Member Functions
void	run_calculator (core::pose::Pose const &pose, std::string const &calculator, std::string const &calculation, utility::vector1_bool &residues) const
	this is the only real function - it takes a calculator name and calculation, and a PackerTask-compatible vector, and flips booleans in the vector according to the calculator More...

Detailed Description

This base class defines an interface for TaskOperations which use PoseMetricCalculators to pick out certain residues in a pose. The apply function takes a vector of PoseMetricCalculators and a vector of calculation queries, and uses those queries to shape the PackerTask. This was designed to work with NeighborsByDistanceCalculator, NeighborhoodByDistanceCalculator, and InterfaceNeighborDefinitionCalculator; in general it works when the calculators can return MetricValue< std::set< core::Size > > (a std::set of resids).

Definition at line 30 of file RestrictOperationsBase.hh.

Member Typedef Documentation

typedef TaskOperation protocols::toolbox::task_operations::RestrictOperationsBase::parent

Definition at line 35 of file RestrictOperationsBase.hh.

typedef core::pack::task::operation::TaskOperation protocols::toolbox::task_operations::RestrictOperationsBase::TaskOperation

Definition at line 33 of file RestrictOperationsBase.hh.

typedef core::pack::task::operation::TaskOperationOP protocols::toolbox::task_operations::RestrictOperationsBase::TaskOperationOP

Definition at line 34 of file RestrictOperationsBase.hh.

Constructor & Destructor Documentation

protocols::toolbox::task_operations::RestrictOperationsBase::RestrictOperationsBase ( )

Definition at line 38 of file RestrictOperationsBase.cc.

protocols::toolbox::task_operations::RestrictOperationsBase::~RestrictOperationsBase ( )

virtual

Definition at line 40 of file RestrictOperationsBase.cc.

Member Function Documentation

virtual void protocols::toolbox::task_operations::RestrictOperationsBase::apply	(	core::pose::Pose const &	,
		core::pack::task::PackerTask &
	)		const

pure virtual

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.

virtual TaskOperationOP protocols::toolbox::task_operations::RestrictOperationsBase::clone ( ) const

pure virtual

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

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

void protocols::toolbox::task_operations::RestrictOperationsBase::run_calculator	(	core::pose::Pose const &	pose,
		std::string const &	calculator,
		std::string const &	calculation,
		utility::vector1_bool &	residues
	)		const

protected

this is the only real function - it takes a calculator name and calculation, and a PackerTask-compatible vector, and flips booleans in the vector according to the calculator

Definition at line 43 of file RestrictOperationsBase.cc.

References core::sequence::end, core::pose::Pose::metric(), and core::pose::Pose::total_residue().

Referenced by protocols::toolbox::task_operations::RestrictToInterfaceOperation::apply(), protocols::toolbox::task_operations::RestrictByCalculatorsOperation::apply(), and protocols::toolbox::task_operations::RestrictToNeighborhoodOperation::apply().

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

src/protocols/toolbox/task_operations/RestrictOperationsBase.hh
src/protocols/toolbox/task_operations/RestrictOperationsBase.cc

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation