protocols::jd3::job_summaries::EnergyJobSummary Class Reference

A JobSummary that simply stores the energy from a job. More...

#include <EnergyJobSummary.hh>

Inheritance diagram for protocols::jd3::job_summaries::EnergyJobSummary:

Public Member Functions
	EnergyJobSummary ()
	EnergyJobSummary (core::Real energy)
	EnergyJobSummary (core::pose::Pose const &pose)
	~EnergyJobSummary () override
void	extract_energy (core::pose::Pose const &pose)
	Extract the energy fromt the Energies object of the pose. More...
void	energy (core::Real setting)
	Set an energy of the job. More...
core::Real	energy () const
	Get the energy stored in this JobSummary. More...
Public Member Functions inherited from protocols::jd3::JobSummary
	JobSummary ()
	~JobSummary () override

Private Attributes
core::Real	energy_ = 0.0

Detailed Description

A JobSummary that simply stores the energy from a job.

Constructor & Destructor Documentation

protocols::jd3::job_summaries::EnergyJobSummary::EnergyJobSummary

(

)

protocols::jd3::job_summaries::EnergyJobSummary::EnergyJobSummary

(

core::Real

energy

)

protocols::jd3::job_summaries::EnergyJobSummary::EnergyJobSummary

(

core::pose::Pose const &

pose

)

References extract_energy().

protocols::jd3::job_summaries::EnergyJobSummary::~EnergyJobSummary ( )

overridedefault

Member Function Documentation

void protocols::jd3::job_summaries::EnergyJobSummary::energy

(

core::Real

setting

)

Set an energy of the job.

References energy_.

Referenced by protocols::multistage_rosetta_scripts::MRSJobQueen::completed_job_summary().

core::Real protocols::jd3::job_summaries::EnergyJobSummary::energy

(

)

const

Get the energy stored in this JobSummary.

References energy_.

void protocols::jd3::job_summaries::EnergyJobSummary::extract_energy

(

core::pose::Pose const &

pose

)

Extract the energy fromt the Energies object of the pose.

References core::pose::Pose::energies(), core::scoring::Energies::energies_updated(), energy_, and core::scoring::Energies::total_energy().

Referenced by EnergyJobSummary().

Member Data Documentation

core::Real protocols::jd3::job_summaries::EnergyJobSummary::energy_ = 0.0

private

Referenced by energy(), and extract_energy().

---

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

• src/protocols/jd3/job_summaries/EnergyJobSummary.hh
• src/protocols/jd3/job_summaries/EnergyJobSummary.cc