Rosetta
Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
protocols::pose_reporters::RMSDReporter Class Reference

Report the RMSD between two poses. More...

#include <BasicPosePropertyReporters.hh>

Inheritance diagram for protocols::pose_reporters::RMSDReporter:
Inheritance graph
[legend]

Public Member Functions

 RMSDReporter ()
 
std::string get_name () const override
 Each derived selector must specify its name. More...
 
core::Real report_property (core::pose::Pose &p1, core::pose::Pose &p2) const override
 Report the RMSD between poses p1 and p2 Depending on the mode, this can be either all atom or CA RMSD, optionally with residue selection. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 Called by PosePropertyReporterFactory when constructing new PosePropertyReporters. Takes care of the specific selector's parsing. More...
 
- Public Member Functions inherited from protocols::rosetta_scripts::PosePropertyReporter
virtual core::Real report_property (core::pose::Pose &p) const
 Reports a specific property for the provided pose. More...
 

Static Public Member Functions

static std::string name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- Static Public Member Functions inherited from protocols::rosetta_scripts::PosePropertyReporter
static std::string name ()
 

Private Types

enum  { MODE_NONE , MODE_CA_rmsd , MODE_all_atom_rmsd }
 

Private Attributes

core::Size mode_
 
core::select::residue_selector::ResidueSelectorCOP residues_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::rosetta_scripts::PosePropertyReporter
 PosePropertyReporter ()
 
 ~PosePropertyReporter () override
 

Detailed Description

Report the RMSD between two poses.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
MODE_NONE 
MODE_CA_rmsd 
MODE_all_atom_rmsd 

Constructor & Destructor Documentation

◆ RMSDReporter()

protocols::pose_reporters::RMSDReporter::RMSDReporter ( )

Member Function Documentation

◆ get_name()

std::string protocols::pose_reporters::RMSDReporter::get_name ( ) const
inlineoverridevirtual

Each derived selector must specify its name.

Implements protocols::rosetta_scripts::PosePropertyReporter.

References name().

◆ name()

static std::string protocols::pose_reporters::RMSDReporter::name ( )
inlinestatic

Referenced by get_name(), and provide_xml_schema().

◆ parse_my_tag()

void protocols::pose_reporters::RMSDReporter::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data 
)
overridevirtual

Called by PosePropertyReporterFactory when constructing new PosePropertyReporters. Takes care of the specific selector's parsing.

Reimplemented from protocols::rosetta_scripts::PosePropertyReporter.

References core::pose::get_resnum_selector(), mode_, MODE_all_atom_rmsd, MODE_CA_rmsd, MODE_NONE, and residues_.

◆ provide_xml_schema()

void protocols::pose_reporters::RMSDReporter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ report_property()

core::Real protocols::pose_reporters::RMSDReporter::report_property ( core::pose::Pose p1,
core::pose::Pose p2 
) const
overridevirtual

Report the RMSD between poses p1 and p2 Depending on the mode, this can be either all atom or CA RMSD, optionally with residue selection.

Reimplemented from protocols::rosetta_scripts::PosePropertyReporter.

References core::scoring::all_atom_rmsd(), core::scoring::CA_rmsd(), core::select::get_residues_from_subset(), mode_, MODE_all_atom_rmsd, MODE_CA_rmsd, residues_, core::pose::Pose::sequence(), and protocols::TR().

Member Data Documentation

◆ mode_

core::Size protocols::pose_reporters::RMSDReporter::mode_
private

Referenced by parse_my_tag(), and report_property().

◆ residues_

core::select::residue_selector::ResidueSelectorCOP protocols::pose_reporters::RMSDReporter::residues_
private

Referenced by parse_my_tag(), and report_property().


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