protocols::pose_metric_calculators::CatPiCalculator Class Reference

#include <CatPiCalculator.hh>

Inheritance diagram for protocols::pose_metric_calculators::CatPiCalculator:

Public Member Functions
	CatPiCalculator ()
	default constructor sets distance_cutoff to 5.0. This is what is usually defined as a Hbond between heavy atom (carbon) and Hydrogen More...
	CatPiCalculator (core::Real dist_cutoff)
	constructur where you define what the distance cutoff is for the pi pi More...
core::pose::metrics::PoseMetricCalculatorOP	clone () const override
Public Member Functions inherited from core::pose::metrics::StructureDependentCalculator
	StructureDependentCalculator ()
void	notify_structure_change () override
void	get (std::string const &key, basic::MetricValueBase &val, Pose const &this_pose) override
std::string	get (std::string const &key, Pose const &this_pose) override
Public Member Functions inherited from core::pose::metrics::PoseMetricCalculator
	PoseMetricCalculator ()
virtual void	notify_energy_change ()

Protected Member Functions
void	lookup (std::string const &key, basic::MetricValueBase *valptr) const override
std::string	print (std::string const &key) const override
void	recompute (core::pose::Pose const &this_pose) override
	not sure why they name this function recompute as you are actually computing the metric. Whateva More...

Private Attributes
core::Real	distance_cutoff_
core::Size	cat_pi_total_

Constructor & Destructor Documentation

CatPiCalculator() [1/2]

protocols::pose_metric_calculators::CatPiCalculator::CatPiCalculator

(

)

default constructor sets distance_cutoff to 5.0. This is what is usually defined as a Hbond between heavy atom (carbon) and Hydrogen

CatPiCalculator() [2/2]

protocols::pose_metric_calculators::CatPiCalculator::CatPiCalculator

(

core::Real

dist_cutoff

)

constructur where you define what the distance cutoff is for the pi pi

Member Function Documentation

clone()

core::pose::metrics::PoseMetricCalculatorOP protocols::pose_metric_calculators::CatPiCalculator::clone ( ) const

inlineoverridevirtual

Implements core::pose::metrics::PoseMetricCalculator.

References distance_cutoff_.

lookup()

void protocols::pose_metric_calculators::CatPiCalculator::lookup ( std::string const &  key, basic::MetricValueBase *  valptr  ) const

overrideprotectedvirtual

Implements core::pose::metrics::StructureDependentCalculator.

References cat_pi_total_.

print()

std::string protocols::pose_metric_calculators::CatPiCalculator::print ( std::string const &  key ) const

overrideprotectedvirtual

Implements core::pose::metrics::StructureDependentCalculator.

References cat_pi_total_, and core::id::to_string().

recompute()

void protocols::pose_metric_calculators::CatPiCalculator::recompute ( core::pose::Pose const &  this_pose )

overrideprotectedvirtual

not sure why they name this function recompute as you are actually computing the metric. Whateva

Implements core::pose::metrics::StructureDependentCalculator.

References core::conformation::Residue::atom_name(), cat_pi_total_, core::kinematics::distance(), distance_cutoff_, core::conformation::Residue::first_sidechain_atom(), core::conformation::Residue::Hpos_polar_sc(), core::conformation::Residue::name3(), core::conformation::Residue::nheavyatoms(), core::pose::Pose::residue(), core::pose::Pose::size(), and core::conformation::Residue::xyz().

Member Data Documentation

cat_pi_total_

core::Size protocols::pose_metric_calculators::CatPiCalculator::cat_pi_total_

private

Referenced by lookup(), print(), and recompute().

distance_cutoff_

core::Real protocols::pose_metric_calculators::CatPiCalculator::distance_cutoff_

private

Referenced by clone(), and recompute().

---

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

• src/protocols/pose_metric_calculators/CatPiCalculator.hh
• src/protocols/pose_metric_calculators/CatPiCalculator.cc