Rosetta 3.4
Public Types | Public Member Functions | Protected Member Functions
protocols::toolbox::task_operations::RestrictOperationsBase Class Reference

#include <RestrictOperationsBase.hh>

Inheritance diagram for protocols::toolbox::task_operations::RestrictOperationsBase:
Inheritance graph
[legend]
Collaboration diagram for protocols::toolbox::task_operations::RestrictOperationsBase:
Collaboration graph
[legend]

List of all members.

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
 Create another task operation of the type matching the most-derived version of the class.
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.

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

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


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]
virtual TaskOperationOP protocols::toolbox::task_operations::RestrictOperationsBase::clone ( ) const [pure virtual]
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 core::sequence::end, core::pose::Pose::metric(), and core::pose::Pose::total_residue().

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines