protocols::task_operations::RestrictToInterfaceOperation Class Reference

#include <RestrictToInterfaceOperation.hh>

Inheritance diagram for protocols::task_operations::RestrictToInterfaceOperation:

Public Types
typedef RestrictOperationsBase	parent
Public Types inherited from protocols::task_operations::RestrictOperationsBase
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::TagCOP	TagCOP
typedef basic::datacache::DataMap	DataMap
typedef pose::Pose	Pose

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)
	~RestrictToInterfaceOperation () override
TaskOperationOP	clone () const override
void	apply (core::pose::Pose const &, core::pack::task::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...
Public Member Functions inherited from protocols::task_operations::RestrictOperationsBase
	RestrictOperationsBase ()
	~RestrictOperationsBase () override
Public Member Functions inherited from core::pack::task::operation::TaskOperation
	~TaskOperation () override
virtual void	parse_tag (TagCOP, DataMap &)
	Used to parse an xml-like tag to load parameters and properties. More...
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 void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
static std::string	keyname ()

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::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

typedef RestrictOperationsBase protocols::task_operations::RestrictToInterfaceOperation::parent

Constructor & Destructor Documentation

protocols::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().

protocols::task_operations::RestrictToInterfaceOperation::RestrictToInterfaceOperation

(

std::string const &

calculator

)

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

protocols::task_operations::RestrictToInterfaceOperation::~RestrictToInterfaceOperation ( )

overridedefault

Member Function Documentation

void protocols::task_operations::RestrictToInterfaceOperation::apply ( core::pose::Pose const &  , core::pack::task::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 protocols::task_operations::RestrictOperationsBase.

References calculator_name_, protocols::antibody::design::repack, core::pack::task::PackerTask::restrict_to_residues(), protocols::task_operations::RestrictOperationsBase::run_calculator(), and core::pose::Pose::size().

core::pack::task::operation::TaskOperationOP protocols::task_operations::RestrictToInterfaceOperation::clone ( ) const

overridevirtual

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

Implements protocols::task_operations::RestrictOperationsBase.

static std::string protocols::task_operations::RestrictToInterfaceOperation::keyname ( )

inlinestatic

Referenced by protocols::task_operations::RestrictToInterfaceOperationCreator::keyname(), and provide_xml_schema().

void protocols::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 protocols::task_operations::TR().

Referenced by RestrictToInterfaceOperation().

void protocols::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 core::id::to_string().

Referenced by make_calculator().

void protocols::task_operations::RestrictToInterfaceOperation::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References keyname(), and core::pack::task::operation::task_op_schema_empty().

Referenced by protocols::task_operations::RestrictToInterfaceOperationCreator::provide_xml_schema().

Member Data Documentation

std::string protocols::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:

• src/protocols/task_operations/RestrictToInterfaceOperation.hh
• src/protocols/task_operations/RestrictToInterfaceOperation.cc