A TaskOperation that Disables packing +/or design of a particular antibody region. By Default, disables packing and design of the cdr_region. Make sure to set the region you want disabled. More...

#include <DisableAntibodyRegionOperation.hh>

Inheritance diagram for protocols::antibody::task_operations::DisableAntibodyRegionOperation:

[legend]

Public Member Functions
	DisableAntibodyRegionOperation ()
	Default constructor. Do not use this. More...

	DisableAntibodyRegionOperation (AntibodyInfoCOP ab_info)
	Constructor setting only AntibodyInfo. More...

	DisableAntibodyRegionOperation (AntibodyInfoCOP ab_info, AntibodyRegionEnum region)
	Constructor setting AntibodyInfo and the region. More...

	DisableAntibodyRegionOperation (AntibodyInfoCOP ab_info, AntibodyRegionEnum region, bool disable_packing_and_design)
	Constructor setting the region and to fully disable the region. If disable_packing_and_design is set to False, will only disable design. More...

	DisableAntibodyRegionOperation (DisableAntibodyRegionOperation const &src)

	~DisableAntibodyRegionOperation () override

core::pack::task::operation::TaskOperationOP	clone () const override
	Create another task operation of the type matching the most-derived version of the class. More...

void	parse_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Configure from a RosettaScripts XML tag. More...

void	apply (core::pose::Pose const &pose, core::pack::task::PackerTask &task) 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...

void	set_region (AntibodyRegionEnum region)

void	set_disable_packing_and_design (bool disable_packing_and_design)
	If disable_packing_and_design is set to False, will only disable design. More...

void	set_defaults ()

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

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 std::string	keyname ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
AntibodyInfoCOP	ab_info_

AntibodyRegionEnum	region_

bool	disable_packing_and_design_

AntibodyNumberingSchemeEnum	numbering_scheme_
	Needed for default and RS constructor. More...

CDRDefinitionEnum	cdr_definition_

Additional Inherited Members
Public Types inherited from core::pack::task::operation::TaskOperation
typedef utility::tag::TagCOP	TagCOP

typedef basic::datacache::DataMap	DataMap

typedef pose::Pose	Pose

Detailed Description

A TaskOperation that Disables packing +/or design of a particular antibody region. By Default, disables packing and design of the cdr_region. Make sure to set the region you want disabled.

Constructor & Destructor Documentation

protocols::antibody::task_operations::DisableAntibodyRegionOperation::DisableAntibodyRegionOperation ( )

Default constructor. Do not use this.

References set_defaults().

protocols::antibody::task_operations::DisableAntibodyRegionOperation::DisableAntibodyRegionOperation ( AntibodyInfoCOP ab_info )

Constructor setting only AntibodyInfo.

References set_defaults().

protocols::antibody::task_operations::DisableAntibodyRegionOperation::DisableAntibodyRegionOperation	(	AntibodyInfoCOP	ab_info,
		AntibodyRegionEnum	region
	)

Constructor setting AntibodyInfo and the region.

References region_, and set_defaults().

protocols::antibody::task_operations::DisableAntibodyRegionOperation::DisableAntibodyRegionOperation	(	AntibodyInfoCOP	ab_info,
		AntibodyRegionEnum	region,
		bool	disable_packing_and_design
	)

Constructor setting the region and to fully disable the region. If disable_packing_and_design is set to False, will only disable design.

References disable_packing_and_design_, region_, and set_defaults().

protocols::antibody::task_operations::DisableAntibodyRegionOperation::DisableAntibodyRegionOperation ( DisableAntibodyRegionOperation const & src )

References ab_info_.

protocols::antibody::task_operations::DisableAntibodyRegionOperation::~DisableAntibodyRegionOperation ( )

overridedefault

Member Function Documentation

void protocols::antibody::task_operations::DisableAntibodyRegionOperation::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 core::pack::task::operation::TaskOperation.

References ab_info_, core::pack::task::operation::RestrictResidueToRepacking::apply(), core::pack::task::operation::PreventRepacking::apply(), cdr_definition_, disable_packing_and_design_, core::pack::task::operation::RestrictResidueToRepacking::include_residue(), core::pack::task::operation::PreventRepacking::include_residue(), numbering_scheme_, region_, and core::pose::Pose::size().

TaskOperationOP protocols::antibody::task_operations::DisableAntibodyRegionOperation::clone ( ) const

overridevirtual

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

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

std::string protocols::antibody::task_operations::DisableAntibodyRegionOperation::keyname ( )

static

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

void protocols::antibody::task_operations::DisableAntibodyRegionOperation::parse_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &
	)

overridevirtual

Configure from a RosettaScripts XML tag.

Reimplemented from core::pack::task::operation::TaskOperation.

References protocols::antibody::AntibodyEnumManager::antibody_region_string_to_enum(), cdr_definition_, protocols::antibody::AntibodyEnumManager::cdr_definition_string_to_enum(), disable_packing_and_design_, numbering_scheme_, protocols::antibody::AntibodyEnumManager::numbering_scheme_string_to_enum(), region_, and protocols::antibody::TR().

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

static

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

Referenced by protocols::antibody::task_operations::DisableAntibodyRegionOperationCreator::provide_xml_schema().

void protocols::antibody::task_operations::DisableAntibodyRegionOperation::set_defaults ( )

References cdr_definition_, protocols::antibody::AntibodyEnumManager::cdr_definition_string_to_enum(), protocols::antibody::cdr_region, disable_packing_and_design_, numbering_scheme_, protocols::antibody::AntibodyEnumManager::numbering_scheme_string_to_enum(), and region_.

Referenced by DisableAntibodyRegionOperation().

void protocols::antibody::task_operations::DisableAntibodyRegionOperation::set_disable_packing_and_design ( bool disable_packing_and_design )

If disable_packing_and_design is set to False, will only disable design.

References disable_packing_and_design_.

void protocols::antibody::task_operations::DisableAntibodyRegionOperation::set_region ( AntibodyRegionEnum region )

References region_.

Member Data Documentation

AntibodyInfoCOP protocols::antibody::task_operations::DisableAntibodyRegionOperation::ab_info_

private

Referenced by apply(), and DisableAntibodyRegionOperation().

CDRDefinitionEnum protocols::antibody::task_operations::DisableAntibodyRegionOperation::cdr_definition_

private

Referenced by apply(), parse_tag(), and set_defaults().

bool protocols::antibody::task_operations::DisableAntibodyRegionOperation::disable_packing_and_design_

private

Referenced by apply(), DisableAntibodyRegionOperation(), parse_tag(), set_defaults(), and set_disable_packing_and_design().

AntibodyNumberingSchemeEnum protocols::antibody::task_operations::DisableAntibodyRegionOperation::numbering_scheme_

private

Needed for default and RS constructor.

Referenced by apply(), parse_tag(), and set_defaults().

AntibodyRegionEnum protocols::antibody::task_operations::DisableAntibodyRegionOperation::region_

private

Referenced by apply(), DisableAntibodyRegionOperation(), parse_tag(), set_defaults(), and set_region().

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

src/protocols/antibody/task_operations/DisableAntibodyRegionOperation.hh
src/protocols/antibody/task_operations/DisableAntibodyRegionOperation.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation