Rosetta Protocols  2014.35
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::toolbox::task_operations::RestrictToInterfaceOperation Class Reference

#include <RestrictToInterfaceOperation.hh>

Public Types

typedef RestrictOperationsBase parent
 
- Public Types inherited from protocols::toolbox::task_operations::RestrictOperationsBase
typedef
core::pack::task::operation::TaskOperation 
TaskOperation
 
typedef
core::pack::task::operation::TaskOperationOP 
TaskOperationOP
 
typedef TaskOperation parent
 

Public Member Functions

 RestrictToInterfaceOperation (core::Size upper_chain=1, core::Size lower_chain=2)
 this ctor will generate the calculator for you (may use defaults) More...
 
 RestrictToInterfaceOperation (std::string const &calculator)
 
virtual ~RestrictToInterfaceOperation ()
 
virtual TaskOperationOP clone () const
 
virtual void apply (core::pose::Pose const &, core::pack::task::PackerTask &) const
 
- Public Member Functions inherited from protocols::toolbox::task_operations::RestrictOperationsBase
 RestrictOperationsBase ()
 
virtual ~RestrictOperationsBase ()
 

Private Member Functions

void make_calculator (core::Size upper_chain, core::Size lower_chain)
 constructor helper function - makes the PoseMetricCalculator More...
 
void make_name (core::Size upper_chain, core::Size lower_chain)
 constructor helper function - names the PoseMetricCalculator More...
 

Private Attributes

std::string calculator_name_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::toolbox::task_operations::RestrictOperationsBase
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 class is a TaskOperation to prevent repacking of residues not near an interface.

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::toolbox::task_operations::RestrictToInterfaceOperation::RestrictToInterfaceOperation ( core::Size  upper_chain = 1,
core::Size  lower_chain = 2 
)

this ctor will generate the calculator for you (may use defaults)

References make_calculator().

Referenced by clone(), and protocols::toolbox::task_operations::RestrictToInterfaceOperationCreator::create_task_operation().

protocols::toolbox::task_operations::RestrictToInterfaceOperation::RestrictToInterfaceOperation ( std::string const &  calculator)

this ctor assumes a pregenerated calculator - if you want a particular non-default cutoff distance

protocols::toolbox::task_operations::RestrictToInterfaceOperation::~RestrictToInterfaceOperation ( )
virtual

Member Function Documentation

void protocols::toolbox::task_operations::RestrictToInterfaceOperation::apply ( core::pose::Pose const &  pose,
core::pack::task::PackerTask task 
) const
virtual
core::pack::task::operation::TaskOperationOP protocols::toolbox::task_operations::RestrictToInterfaceOperation::clone ( ) const
virtual

be warned if you use clone that you'll not get a new interface calculator

Implements protocols::toolbox::task_operations::RestrictOperationsBase.

References RestrictToInterfaceOperation().

void protocols::toolbox::task_operations::RestrictToInterfaceOperation::make_calculator ( core::Size  upper_chain,
core::Size  lower_chain 
)
private

constructor helper function - makes the PoseMetricCalculator

private helper function to make calculator - runs in the ctor

References calculator_name_, make_name(), and Warning().

Referenced by RestrictToInterfaceOperation().

void protocols::toolbox::task_operations::RestrictToInterfaceOperation::make_name ( core::Size  upper_chain,
core::Size  lower_chain 
)
private

constructor helper function - names the PoseMetricCalculator

private helper function to name calculator- runs in the ctor

References calculator_name_, and utility::to_string().

Referenced by make_calculator().

Member Data Documentation

std::string protocols::toolbox::task_operations::RestrictToInterfaceOperation::calculator_name_
private

Referenced by apply(), make_calculator(), and make_name().


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