protocols::canonical_sampling::DbTrajectoryReader Class Reference

Read poses from a DbTrajectoryRecorder trajectory. More...

#include <DbTrajectoryReader.hh>

Public Member Functions
	DbTrajectoryReader ()
	Default constructor. More...
	DbTrajectoryReader (Size job_id)
	Constructor which accepts a job id. More...
void	set_job_id (Size job_id)
	Set the job id. This controls which records are selected. More...
Size	get_num_iterations () const
	Return the number of iterations that were recorded for this job. More...
utility::vector1< Size >	get_iterations () const
	Return a vector listing every iteration recorded for this job. More...
Pose	get_pose (Size iteration) const
	Return the pose recorded for the given iteration. More...
utility::vector1< Pose >	get_poses () const
	Return all the poses contained in this trajectory. More...

Private Attributes
utility::sql_database::sessionOP	db_session_
Size	job_id_

Detailed Description

Read poses from a DbTrajectoryRecorder trajectory.

This class is meant to be used for analysis scripts that run after the simulation has been completed. For this reason, no effort was made to make this class especially efficient. Use get_poses() to return every pose stored in the trajectory, or get_pose() to return the pose associated with the given iteration.

Constructor & Destructor Documentation

protocols::canonical_sampling::DbTrajectoryReader::DbTrajectoryReader

(

)

Default constructor.

References basic::database::get_db_session().

protocols::canonical_sampling::DbTrajectoryReader::DbTrajectoryReader

(

Size

job_id

)

Constructor which accepts a job id.

References basic::database::get_db_session().

Member Function Documentation

vector1< Size > protocols::canonical_sampling::DbTrajectoryReader::get_iterations

(

)

const

Return a vector listing every iteration recorded for this job.

References protocols::pack_daemon::error_message, iterations, safely_prepare_statement(), safely_read_from_database(), table_exists(), and utility_exit_with_message.

Size protocols::canonical_sampling::DbTrajectoryReader::get_num_iterations

(

)

const

Return the number of iterations that were recorded for this job.

Pose protocols::canonical_sampling::DbTrajectoryReader::get_pose

(

Size

iteration

)

const

Return the pose recorded for the given iteration.

References core::pose::Pose::energies(), protocols::pack_daemon::error_message, make_vector1(), core::io::silent::SilentFileData::read_stream(), safely_prepare_statement(), safely_read_from_database(), score, table_exists(), tags, core::scoring::Energies::total_energies(), core::scoring::Energies::total_energy(), core::scoring::total_score, and utility_exit_with_message.

vector1< Pose > protocols::canonical_sampling::DbTrajectoryReader::get_poses

(

)

const

Return all the poses contained in this trajectory.

References iterations.

void protocols::canonical_sampling::DbTrajectoryReader::set_job_id

(

Size

job_id

)

Set the job id. This controls which records are selected.

Member Data Documentation

utility::sql_database::sessionOP protocols::canonical_sampling::DbTrajectoryReader::db_session_

private

Size protocols::canonical_sampling::DbTrajectoryReader::job_id_

private

---

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

• symlinks/rosetta/src/protocols/canonical_sampling/DbTrajectoryReader.hh
• symlinks/rosetta/src/protocols/canonical_sampling/DbTrajectoryReader.cc