Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
protocols::environment::claims::EnvClaim Class Referenceabstract

#include <EnvClaim.hh>

Inheritance diagram for protocols::environment::claims::EnvClaim:
Inheritance graph
[legend]

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

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
void protocols::environment::claims::EnvClaim::define_envclaim_schema_group ( utility::tag::XMLSchemaDefinition &  xsd)
static
std::string protocols::environment::claims::EnvClaim::envclaim_ct_namer ( std::string  tag_name)
static
std::string protocols::environment::claims::EnvClaim::envclaim_group_name ( )
static
bool protocols::environment::claims::EnvClaim::is_claim ( std::string const &  name)
static
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
ControlStrength protocols::environment::claims::EnvClaim::parse_ctrl_str ( std::string const &  str) const
protected
void protocols::environment::claims::EnvClaim::queue_for_annotation ( std::string const &  label,
ResidueSelectorCOP  selector 
)
protected
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
virtual std::string protocols::environment::claims::EnvClaim::type ( ) const
pure virtual
DOFElement protocols::environment::claims::EnvClaim::wrap_dof_id ( core::id::DOF_ID const &  id) const
protectedvirtual
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: