Rosetta 3.4
Public Types | Public Member Functions | Static Public Member Functions
protocols::features::DatabaseJobOutputter Class Reference

#include <DatabaseJobOutputter.hh>

Inheritance diagram for protocols::features::DatabaseJobOutputter:
Inheritance graph
[legend]
Collaboration diagram for protocols::features::DatabaseJobOutputter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
protocols::jd2::FileJobOutputter 
parent

Public Member Functions

 DatabaseJobOutputter ()
virtual ~DatabaseJobOutputter ()
void load_options_from_option_system ()
 load options from option sytem
void set_database_fname (std::string const &database_fname)
 Set database file name.
std::string get_database_fname () const
 Get database file name.
virtual void flush ()
 see parent class for explanation
virtual void final_pose (protocols::jd2::JobCOP job, core::pose::Pose const &pose)
 this function outputs the final result of a job.
virtual void other_pose (protocols::jd2::JobCOP job, core::pose::Pose const &pose, std::string const &tag, int copy_count=-1, bool score_only=false)
 this function is intended for saving mid-protocol poses; for example the final centroid structure in a combined centroid/fullatom protocol.
virtual bool job_has_completed (protocols::jd2::JobCOP job)
 this function is not used for output, but it belongs here since it needs to check the same output locations as the class normally writes to. This class checks wherever output goes to see if the job's expected output already exists (on disk or whatever). This is the most basic form of checkpointing.
virtual std::string output_name (protocols::jd2::JobCOP job)
 this is the master function for determining the unique output identifier for a job

Static Public Member Functions

static void register_options ()

Detailed Description

this is a implementation of JobOutputter for database-based output.


Member Typedef Documentation

Reimplemented from protocols::jd2::FileJobOutputter.


Constructor & Destructor Documentation

protocols::features::DatabaseJobOutputter::DatabaseJobOutputter ( )
protocols::features::DatabaseJobOutputter::~DatabaseJobOutputter ( ) [virtual]

Member Function Documentation

void protocols::features::DatabaseJobOutputter::final_pose ( protocols::jd2::JobCOP  job,
core::pose::Pose const &  pose 
) [virtual]

this function outputs the final result of a job.

Implements protocols::jd2::FileJobOutputter.

References output_name().

void protocols::features::DatabaseJobOutputter::flush ( ) [virtual]

see parent class for explanation

Reimplemented from protocols::jd2::JobOutputter.

std::string protocols::features::DatabaseJobOutputter::get_database_fname ( ) const

Get database file name.

bool protocols::features::DatabaseJobOutputter::job_has_completed ( protocols::jd2::JobCOP  job) [virtual]

this function is not used for output, but it belongs here since it needs to check the same output locations as the class normally writes to. This class checks wherever output goes to see if the job's expected output already exists (on disk or whatever). This is the most basic form of checkpointing.

Implements protocols::jd2::FileJobOutputter.

References output_name().

void protocols::features::DatabaseJobOutputter::load_options_from_option_system ( )

load options from option sytem

References set_database_fname().

Referenced by DatabaseJobOutputter().

void protocols::features::DatabaseJobOutputter::other_pose ( protocols::jd2::JobCOP  job,
core::pose::Pose const &  pose,
std::string const &  tag,
int  copy_count = -1,
bool  score_only = false 
) [virtual]

this function is intended for saving mid-protocol poses; for example the final centroid structure in a combined centroid/fullatom protocol.

Implements protocols::jd2::FileJobOutputter.

std::string protocols::features::DatabaseJobOutputter::output_name ( protocols::jd2::JobCOP  job) [virtual]

this is the master function for determining the unique output identifier for a job

Database tags should preserve the FULL NAME such that we don't end up with duplicate tags. This will cause problems on BOINC if changed.

Implements protocols::jd2::FileJobOutputter.

References protocols::jd2::JobOutputter::affixed_numbered_name().

Referenced by final_pose(), and job_has_completed().

void protocols::features::DatabaseJobOutputter::register_options ( ) [static]
void protocols::features::DatabaseJobOutputter::set_database_fname ( std::string const &  database_fname)

Set database file name.

Referenced by load_options_from_option_system().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines