container for managing PoseMetricCalculators More...

#include <PoseMetricContainer.hh>

Inheritance diagram for core::pose::metrics::PoseMetricContainer:

Collaboration diagram for core::pose::metrics::PoseMetricContainer:

Public Member Functions
	PoseMetricContainer ()
	default destructor More...

	PoseMetricContainer (PoseMetricContainer const &src)
	copy constructor More...

virtual	~PoseMetricContainer ()
	default destructor More...

PoseMetricContainer &	operator= (PoseMetricContainer const &src)
	copy assignment More...

void	clear ()
	clear the list of metric calculators, reset flags More...

void	get (std::string const &calculator_name, std::string const &key, basic::MetricValueBase &val, Pose const &this_pose)
	get a value out of a PoseMetricCalculator More...

std::string	print (std::string const &calculator_name, std::string const &key, Pose const &this_pose)
	return a string with the results of a PoseMetricCalculator More...

void	attach_to (core::pose::Pose &pose)
	attach to a Pose More...

void	detach_from ()
	detach from Pose More...

Pose const *	is_observing ()
	is observing a Pose? More...

void	on_pose_destruction_change (core::pose::signals::DestructionEvent const &event)
	upon receiving a pose::signals::DestructionEvent, detaches More...

void	on_pose_energy_change (core::pose::signals::EnergyEvent const &event)
	upon receiving a pose:signals::EnergyEvent, sets flag telling calculators to refresh energy based calculations More...

void	on_pose_conf_change (core::pose::signals::ConformationEvent const &event)
	upon receiving pose::signals::ConformationEvent, sets flag telling calculators to refresh structure based calculations More...

Private Types
typedef std::map< std::string, PoseMetricCalculatorOP >	Name2Calculator

Private Member Functions
void	process_structure_change ()
	set PoseMetricCalculator structure changed flags More...

void	process_energy_change ()
	set PoseMetricCalculator energy changed flags More...

PoseMetricCalculatorOP	get_calculator (std::string const &calculator_name)
	get a PoseMetricCalculator by name More...

void	add_calculator (std::string const &calculator_name)
	add a PoseMetricCalculator by name More...

void	clone_calculators (Name2Calculator const &calcs)
	clone calculators, primarily for copy More...

Private Attributes
core::pose::Pose const *	pose_ptr_
	pointer to the Pose being watched More...

bool	structure_is_outdated_
	flag for structure change More...

bool	energies_are_outdated_
	flag for energy change More...

Name2Calculator	metric_calculators_
	the list of metric calculators More...

Detailed Description

container for managing PoseMetricCalculators

Attaches to a Pose and listens to Pose signals. It then notifies stored PoseMetricCalculators to recalculate as-needed.

Definition at line 50 of file PoseMetricContainer.hh.

Member Typedef Documentation

typedef std::map< std::string, PoseMetricCalculatorOP > core::pose::metrics::PoseMetricContainer::Name2Calculator

private

Definition at line 55 of file PoseMetricContainer.hh.

Constructor & Destructor Documentation

core::pose::metrics::PoseMetricContainer::PoseMetricContainer ( )

default destructor

Definition at line 48 of file PoseMetricContainer.cc.

core::pose::metrics::PoseMetricContainer::PoseMetricContainer ( PoseMetricContainer const & src)

copy constructor

Warning: observation of subject Pose in src not duplicated

Definition at line 57 of file PoseMetricContainer.cc.

References clone_calculators(), and metric_calculators_.

core::pose::metrics::PoseMetricContainer::~PoseMetricContainer ( )

virtual

default destructor

Definition at line 68 of file PoseMetricContainer.cc.

References detach_from().

Member Function Documentation

void core::pose::metrics::PoseMetricContainer::add_calculator ( std::string const & calculator_name)

private

add a PoseMetricCalculator by name

Definition at line 227 of file PoseMetricContainer.cc.

References core::pose::metrics::CalculatorFactory::Instance(), metric_calculators_, and core::pose::metrics::CalculatorFactory::retrieve_calculator().

Referenced by get_calculator().

void core::pose::metrics::PoseMetricContainer::attach_to ( core::pose::Pose & pose)

attach to a Pose

Definition at line 108 of file PoseMetricContainer.cc.

References core::pose::Pose::attach_conformation_obs(), core::pose::Pose::attach_destruction_obs(), core::pose::Pose::attach_energy_obs(), detach_from(), energies_are_outdated_, on_pose_conf_change(), on_pose_destruction_change(), on_pose_energy_change(), pose_ptr_, and structure_is_outdated_.

void core::pose::metrics::PoseMetricContainer::clear ( )

clear the list of metric calculators, reset flags

Definition at line 87 of file PoseMetricContainer.cc.

References energies_are_outdated_, metric_calculators_, and structure_is_outdated_.

Referenced by operator=().

void core::pose::metrics::PoseMetricContainer::clone_calculators ( Name2Calculator const & calcs)

private

clone calculators, primarily for copy

Definition at line 234 of file PoseMetricContainer.cc.

References metric_calculators_.

Referenced by operator=(), and PoseMetricContainer().

void core::pose::metrics::PoseMetricContainer::detach_from ( )

detach from Pose

Definition at line 125 of file PoseMetricContainer.cc.

References core::pose::Pose::detach_conformation_obs(), core::pose::Pose::detach_destruction_obs(), core::pose::Pose::detach_energy_obs(), on_pose_conf_change(), on_pose_destruction_change(), on_pose_energy_change(), and pose_ptr_.

Referenced by attach_to(), on_pose_destruction_change(), and ~PoseMetricContainer().

void core::pose::metrics::PoseMetricContainer::get	(	std::string const &	calculator_name,
		std::string const &	key,
		basic::MetricValueBase &	val,
		Pose const &	this_pose
	)