#include <EnvClaim.hh>

Inheritance diagram for protocols::environment::claims::EnvClaim:

Public Member Functions
	~EnvClaim () override
	Virtual destructor. More...

	EnvClaim (ClientMoverOP)

virtual EnvClaimOP	clone () const =0

ClientMoverOP	owner () const
	A clone used by the EnvClaimFactory to instantiate new EnvClaims using an XML tag. More...

void	set_owner (ClientMoverOP owner)

void	annotate (core::pose::Pose const &, core::environment::SequenceAnnotationOP) const
	allow the claim to use any internally queued ResidueSelectors to create sequence annotations. More...

virtual void	yield_elements (FoldTreeSketch const &, ResidueElements &) const
	build ResidueElements that indicate the introduction of a new peptide edge into the fold tree. More...

virtual void	yield_elements (FoldTreeSketch const &, JumpElements &) const
	build the JumpElements that represent the inclusion of a jump in the nascent FoldTree More...

virtual void	yield_elements (FoldTreeSketch const &, CutElements &) const
	build and export the CutElements that represent the inclusion of a cut in the tree. More...

virtual void	yield_elements (FoldTreeSketch const &, CutBiasElements &) const
	build and export the CutElements that represent the inclusion of a cut in the tree. More...

virtual void	yield_elements (core::pose::Pose const &, DOFElements &) const
	build and export DOFElements, which represent control over non-jump dofs (torsions, bond lengths, angles) final conformation. More...

virtual void	show (std::ostream &os) const

virtual std::string	type () const =0

Static Public Member Functions
static EnvClaimOP	make_claim (std::string const &name, ClientMoverOP owner, utility::tag::TagCOP tag, basic::datacache::DataMap &datamap)
	factory method for claims. More...

static bool	is_claim (std::string const &name)

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

static std::string	envclaim_ct_namer (std::string)

static std::string	envclaim_group_name ()

Protected Member Functions
virtual DOFElement	wrap_dof_id (core::id::DOF_ID const &id) const

ControlStrength	parse_ctrl_str (std::string const &str) const

void	queue_for_annotation (std::string const &label, ResidueSelectorCOP selector)

Private Types
typedef core::select::residue_selector::ResidueSelectorCOP	ResidueSelectorCOP

typedef core::environment::FoldTreeSketch	FoldTreeSketch

typedef std::map< std::string, ResidueSelectorCOP >	AnnotatingSelectors

Private Attributes
AnnotatingSelectors	selector_list_

ClientMoverOP	claim_source_

Member Typedef Documentation

typedef std::map< std::string, ResidueSelectorCOP > protocols::environment::claims::EnvClaim::AnnotatingSelectors

private

typedef core::environment::FoldTreeSketch protocols::environment::claims::EnvClaim::FoldTreeSketch

private

typedef core::select::residue_selector::ResidueSelectorCOP protocols::environment::claims::EnvClaim::ResidueSelectorCOP

private

Constructor & Destructor Documentation

protocols::environment::claims::EnvClaim::~EnvClaim ( )

overridedefault

Virtual destructor.

Auto-generated virtual destructor

protocols::environment::claims::EnvClaim::EnvClaim ( ClientMoverOP owner )

Member Function Documentation

void protocols::environment::claims::EnvClaim::annotate	(	core::pose::Pose const &	pose,
		core::environment::SequenceAnnotationOP	ann
	)		const

allow the claim to use any internally queued ResidueSelectors to create sequence annotations.

References core::scoring::pair, and selector_list_.

virtual EnvClaimOP protocols::environment::claims::EnvClaim::clone ( ) const

pure virtual

Implemented in protocols::environment::claims::JumpClaim, protocols::environment::claims::TorsionClaim, protocols::environment::claims::XYZClaim, protocols::environment::claims::VirtResClaim, and protocols::environment::claims::CutBiasClaim.

void protocols::environment::claims::EnvClaim::define_envclaim_schema_group ( utility::tag::XMLSchemaDefinition & xsd )

static

Referenced by protocols::environment::ScriptCM::provide_xml_schema().

std::string protocols::environment::claims::EnvClaim::envclaim_ct_namer ( std::string tag_name )

static

Referenced by define_envclaim_schema_group(), protocols::environment::claims::CutBiasClaim::provide_xml_schema(), protocols::environment::claims::VirtResClaim::provide_xml_schema(), protocols::environment::claims::XYZClaim::provide_xml_schema(), protocols::environment::claims::TorsionClaim::provide_xml_schema(), and protocols::environment::claims::JumpClaim::provide_xml_schema().

std::string protocols::environment::claims::EnvClaim::envclaim_group_name ( )

static

Referenced by define_envclaim_schema_group(), and protocols::environment::ScriptCM::provide_xml_schema().

bool protocols::environment::claims::EnvClaim::is_claim ( std::string const & name )

static

Referenced by protocols::environment::ScriptCM::parse_my_tag().

EnvClaimOP protocols::environment::claims::EnvClaim::make_claim	(	std::string const &	name,
		ClientMoverOP	owner,
		utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	datamap
	)

static

factory method for claims.

Note: I chose not to make a full-on factory implementation with registrators and creators and a factory because there aren't that many different kinds of claims, I think, and that level of complexity is likely superfluous.

References owner(), and protocols::environment::tr().

Referenced by protocols::environment::ScriptCM::parse_my_tag().

ClientMoverOP protocols::environment::claims::EnvClaim::owner ( ) const

A clone used by the EnvClaimFactory to instantiate new EnvClaims using an XML tag.

References claim_source_.

Referenced by make_claim(), set_owner(), protocols::environment::claims::CutBiasClaim::show(), protocols::environment::claims::VirtResClaim::show(), protocols::environment::claims::XYZClaim::show(), protocols::environment::claims::TorsionClaim::show(), protocols::environment::claims::JumpClaim::show(), show(), and protocols::environment::claims::XYZClaim::yield_elements().

ControlStrength protocols::environment::claims::EnvClaim::parse_ctrl_str ( std::string const & str ) const

protected

References protocols::environment::claims::CAN_CONTROL, protocols::environment::claims::DOES_NOT_CONTROL, protocols::environment::claims::EXCLUSIVE, protocols::environment::claims::MUST_CONTROL, and protocols::kinmatch::str().

Referenced by protocols::environment::claims::VirtResClaim::VirtResClaim().

void protocols::environment::claims::EnvClaim::queue_for_annotation	(	std::string const &	label,
		ResidueSelectorCOP	selector
	)

protected

References selector_list_.

Referenced by protocols::environment::claims::CutBiasClaim::CutBiasClaim(), protocols::environment::claims::JumpClaim::JumpClaim(), and protocols::environment::claims::VirtResClaim::VirtResClaim().

void protocols::environment::claims::EnvClaim::set_owner ( ClientMoverOP owner )

inline

References claim_source_, and owner().

void protocols::environment::claims::EnvClaim::show ( std::ostream & os ) const

virtual

Reimplemented in protocols::environment::claims::JumpClaim, protocols::environment::claims::TorsionClaim, protocols::environment::claims::XYZClaim, protocols::environment::claims::VirtResClaim, and protocols::environment::claims::CutBiasClaim.

References owner().

Referenced by protocols::environment::claims::operator<<().

virtual std::string protocols::environment::claims::EnvClaim::type ( ) const

pure virtual

Implemented in protocols::environment::claims::JumpClaim, protocols::environment::claims::TorsionClaim, protocols::environment::claims::XYZClaim, protocols::environment::claims::VirtResClaim, and protocols::environment::claims::CutBiasClaim.

DOFElement protocols::environment::claims::EnvClaim::wrap_dof_id ( core::id::DOF_ID const & id ) const

protectedvirtual

Reimplemented in protocols::environment::claims::TorsionClaim, and protocols::environment::claims::XYZClaim.

References protocols::environment::claims::DOFElement::id.

Referenced by protocols::environment::claims::XYZClaim::wrap_dof_id(), protocols::environment::claims::TorsionClaim::wrap_dof_id(), and protocols::environment::claims::VirtResClaim::yield_elements().

virtual void protocols::environment::claims::EnvClaim::yield_elements	(	FoldTreeSketch const &	,
		ResidueElements &
	)		const

inlinevirtual

build ResidueElements that indicate the introduction of a new peptide edge into the fold tree.

Reimplemented in protocols::environment::claims::VirtResClaim, and protocols::environment::claims::JumpClaim.

virtual void protocols::environment::claims::EnvClaim::yield_elements	(	FoldTreeSketch const &	,
		JumpElements &
	)		const

inlinevirtual

build the JumpElements that represent the inclusion of a jump in the nascent FoldTree

Reimplemented in protocols::environment::claims::VirtResClaim, and protocols::environment::claims::JumpClaim.

virtual void protocols::environment::claims::EnvClaim::yield_elements	(	FoldTreeSketch const &	,
		CutElements &
	)		const

inlinevirtual

build and export the CutElements that represent the inclusion of a cut in the tree.

Reimplemented in protocols::environment::claims::VirtResClaim, and protocols::environment::claims::JumpClaim.

virtual void protocols::environment::claims::EnvClaim::yield_elements	(	FoldTreeSketch const &	,
		CutBiasElements &
	)		const

inlinevirtual

build and export the CutElements that represent the inclusion of a cut in the tree.

Reimplemented in protocols::environment::claims::CutBiasClaim.

virtual void protocols::environment::claims::EnvClaim::yield_elements	(	core::pose::Pose const &	,
		DOFElements &
	)		const

inlinevirtual

build and export DOFElements, which represent control over non-jump dofs (torsions, bond lengths, angles) final conformation.

Reimplemented in protocols::environment::claims::TorsionClaim, protocols::environment::claims::XYZClaim, protocols::environment::claims::VirtResClaim, and protocols::environment::claims::JumpClaim.

Member Data Documentation

ClientMoverOP protocols::environment::claims::EnvClaim::claim_source_

private

Referenced by owner(), and set_owner().

AnnotatingSelectors protocols::environment::claims::EnvClaim::selector_list_

private

Referenced by annotate(), and queue_for_annotation().

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

src/protocols/environment/claims/EnvClaim.hh
src/protocols/environment/claims/EnvClaim.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation