protocols::antibody::residue_selector::AntibodyRegionSelector Class Reference

A simple selector to select residues of particular antibody regions. More...

#include <AntibodyRegionSelector.hh>

Inheritance diagram for protocols::antibody::residue_selector::AntibodyRegionSelector:

Public Member Functions
	AntibodyRegionSelector ()
	Constructor. More...
	AntibodyRegionSelector (AntibodyInfoCOP ab_info)
	Constructor Passing AntibodyInfo. More...
	AntibodyRegionSelector (AntibodyInfoCOP ab_info, AntibodyRegionEnum region)
	Constructor giving the AntibodyRegion to select on. More...
	AntibodyRegionSelector (AntibodyRegionSelector const &src)
	Copy Constructor. More...
void	set_region (AntibodyRegionEnum region)
void	set_ab_info (AntibodyInfoCOP ab_info)
	~AntibodyRegionSelector () override
	Destructor. More...
core::select::residue_selector::ResidueSelectorOP	clone () const override
	Clone operator. More...
core::select::residue_selector::ResidueSubset	apply (core::pose::Pose const &pose) const override
	"Apply" function. More...
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) override
	XML parse. More...
std::string	get_name () const override
	Get the mover class name. More...
Public Member Functions inherited from core::select::residue_selector::ResidueSelector
	ResidueSelector ()
	Constructor. More...
	~ResidueSelector () override
	Destructor. More...
utility::vector1< core::Size >	selection_positions (core::pose::Pose const &pose) const
	Calls apply and returns the Rosetta numbering corresponding to the selected residues. 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 std::string	class_name ()
	Get the mover class name. More...
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
	Provide XSD information, enabling mechanical validation of input XML. More...

Private Member Functions
void	set_defaults ()

Private Attributes
AntibodyInfoCOP	ab_info_
AntibodyRegionEnum	region_
AntibodyNumberingSchemeEnum	numbering_scheme_
	Needed for default and RS constructor. More...
CDRDefinitionEnum	cdr_definition_

Detailed Description

A simple selector to select residues of particular antibody regions.

Constructor & Destructor Documentation

AntibodyRegionSelector() [1/4]

protocols::antibody::residue_selector::AntibodyRegionSelector::AntibodyRegionSelector

(

)

Constructor.

References set_defaults().

AntibodyRegionSelector() [2/4]

protocols::antibody::residue_selector::AntibodyRegionSelector::AntibodyRegionSelector

(

AntibodyInfoCOP

ab_info

)

Constructor Passing AntibodyInfo.

References set_defaults().

AntibodyRegionSelector() [3/4]

protocols::antibody::residue_selector::AntibodyRegionSelector::AntibodyRegionSelector	(	AntibodyInfoCOP	ab_info,
		AntibodyRegionEnum	region
	)

Constructor giving the AntibodyRegion to select on.

References region_, and set_defaults().

AntibodyRegionSelector() [4/4]

protocols::antibody::residue_selector::AntibodyRegionSelector::AntibodyRegionSelector

(

AntibodyRegionSelector const &

src

)

Copy Constructor.

References ab_info_.

~AntibodyRegionSelector()

protocols::antibody::residue_selector::AntibodyRegionSelector::~AntibodyRegionSelector ( )

overridedefault

Destructor.

Member Function Documentation

apply()

ResidueSubset protocols::antibody::residue_selector::AntibodyRegionSelector::apply ( core::pose::Pose const &  pose ) const

overridevirtual

"Apply" function.

Given the pose, generate a vector of bools with entries for every residue in the pose indicating whether each residue is selected ("true") or not ("false").

Implements core::select::residue_selector::ResidueSelector.

References ab_info_, cdr_definition_, numbering_scheme_, region_, core::pose::Pose::size(), and protocols::antibody::unknown_ab_region.

class_name()

std::string protocols::antibody::residue_selector::AntibodyRegionSelector::class_name ( )

static

Get the mover class name.

Referenced by get_name(), protocols::antibody::residue_selector::AntibodyRegionSelectorCreator::keyname(), and provide_xml_schema().

clone()

core::select::residue_selector::ResidueSelectorOP protocols::antibody::residue_selector::AntibodyRegionSelector::clone ( ) const

overridevirtual

Clone operator.

Clone function.

Copy the current object (creating the copy on the heap) and return an owning pointer to the copy. All ResidueSelectors must implement this.

Copy this object and return owning pointer to the copy (created on the heap).

Implements core::select::residue_selector::ResidueSelector.

get_name()

std::string protocols::antibody::residue_selector::AntibodyRegionSelector::get_name ( ) const

overridevirtual

Get the mover class name.

Implements core::select::residue_selector::ResidueSelector.

References class_name().

parse_my_tag()

void protocols::antibody::residue_selector::AntibodyRegionSelector::parse_my_tag ( utility::tag::TagCOP  tag, basic::datacache::DataMap &  datamap  )

overridevirtual

XML parse.

Parse RosettaScripts tags and set up this mover.

Reimplemented from core::select::residue_selector::ResidueSelector.

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

provide_xml_schema()

void protocols::antibody::residue_selector::AntibodyRegionSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

Provide XSD information, enabling mechanical validation of input XML.

References class_name(), and core::pack::palette::xsd_type_definition_w_attributes().

Referenced by protocols::antibody::residue_selector::AntibodyRegionSelectorCreator::provide_xml_schema().

set_ab_info()

void protocols::antibody::residue_selector::AntibodyRegionSelector::set_ab_info

(

AntibodyInfoCOP

ab_info

)

References ab_info_.

set_defaults()

void protocols::antibody::residue_selector::AntibodyRegionSelector::set_defaults ( )

private

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

Referenced by AntibodyRegionSelector().

set_region()

void protocols::antibody::residue_selector::AntibodyRegionSelector::set_region

(

AntibodyRegionEnum

region

)

References region_.

Member Data Documentation

ab_info_

AntibodyInfoCOP protocols::antibody::residue_selector::AntibodyRegionSelector::ab_info_

private

Referenced by AntibodyRegionSelector(), apply(), and set_ab_info().

cdr_definition_

CDRDefinitionEnum protocols::antibody::residue_selector::AntibodyRegionSelector::cdr_definition_

private

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

numbering_scheme_

AntibodyNumberingSchemeEnum protocols::antibody::residue_selector::AntibodyRegionSelector::numbering_scheme_

private

Needed for default and RS constructor.

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

region_

AntibodyRegionEnum protocols::antibody::residue_selector::AntibodyRegionSelector::region_

private

Referenced by AntibodyRegionSelector(), apply(), parse_my_tag(), set_defaults(), and set_region().

---

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

• src/protocols/antibody/residue_selector/AntibodyRegionSelector.hh
• src/protocols/antibody/residue_selector/AntibodyRegionSelector.cc