protocols::toolbox::task_operations::RestrictOperationsBase Class Reference

#include <RestrictOperationsBase.hh>

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

Public Member Functions
	RestrictOperationsBase ()
virtual	~RestrictOperationsBase ()
virtual TaskOperationOP	clone () const =0
virtual void	apply (core::pose::Pose const &, core::pack::task::PackerTask &) const =0

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).

Member Typedef Documentation

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

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

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

Constructor & Destructor Documentation

protocols::toolbox::task_operations::RestrictOperationsBase::RestrictOperationsBase

(

)

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

virtual

Member Function Documentation

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

pure virtual

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

Implemented in protocols::toolbox::task_operations::RestrictToNeighborhoodOperation, protocols::toolbox::task_operations::ProteinInterfaceDesignOperation, protocols::toolbox::task_operations::DesignAroundOperation, protocols::toolbox::task_operations::PreventResiduesFromRepackingOperation, protocols::toolbox::task_operations::RestrictResiduesToRepackingOperation, protocols::toolbox::task_operations::ThreadSequenceOperation, protocols::toolbox::task_operations::RestrictByCalculatorsOperation, protocols::toolbox::task_operations::PreventChainFromRepackingOperation, protocols::toolbox::task_operations::RestrictChainToRepackingOperation, protocols::toolbox::task_operations::RestrictToInterfaceOperation, protocols::toolbox::task_operations::AlignedThreadOperation, protocols::toolbox::task_operations::RestrictToAlignedSegmentsOperation, protocols::toolbox::task_operations::RestrictIdentitiesAtAlignedPositionsOperation, protocols::toolbox::task_operations::SelectResiduesWithinChainOperation, and protocols::toolbox::task_operations::DatabaseThread.

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

pure virtual

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

Implemented in protocols::toolbox::task_operations::RestrictToNeighborhoodOperation, protocols::toolbox::task_operations::ProteinInterfaceDesignOperation, protocols::toolbox::task_operations::DesignAroundOperation, protocols::toolbox::task_operations::PreventResiduesFromRepackingOperation, protocols::toolbox::task_operations::RestrictResiduesToRepackingOperation, protocols::toolbox::task_operations::RestrictByCalculatorsOperation, protocols::toolbox::task_operations::PreventChainFromRepackingOperation, protocols::toolbox::task_operations::RestrictChainToRepackingOperation, protocols::toolbox::task_operations::ThreadSequenceOperation, protocols::toolbox::task_operations::RestrictToInterfaceOperation, protocols::toolbox::task_operations::AlignedThreadOperation, protocols::toolbox::task_operations::RestrictToAlignedSegmentsOperation, protocols::toolbox::task_operations::RestrictIdentitiesAtAlignedPositionsOperation, protocols::toolbox::task_operations::DatabaseThread, and protocols::toolbox::task_operations::SelectResiduesWithinChainOperation.

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

References end, core::pose::Pose::metric(), runtime_assert, core::pose::Pose::total_residue(), and basic::MetricValue< T >::value().

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