Rosetta 3.4
Public Types | Public Member Functions | Protected Member Functions
protocols::jd2::SilentFileJobOutputter Class Reference

#include <SilentFileJobOutputter.hh>

Inheritance diagram for protocols::jd2::SilentFileJobOutputter:
Inheritance graph
[legend]
Collaboration diagram for protocols::jd2::SilentFileJobOutputter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
protocols::jd2::FileJobOutputter 
parent

Public Member Functions

 SilentFileJobOutputter ()
virtual ~SilentFileJobOutputter ()
virtual void flush ()
 this function flushes any internal buffers - see parent class for explanation
virtual void final_pose (JobCOP job, core::pose::Pose const &pose)
 this function outputs the final result of a job.
virtual void other_pose (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 (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 (JobCOP job)
 this is the master function for determining the unique output identifier for a job
virtual std::string filename (JobCOP) const
void set_silent_file_name (utility::file::FileName name)
void set_write_separate_scorefile (bool write_separate_scorefile)
void set_write_no_structures (bool value=true)

Protected Member Functions

core::io::silent::SilentStructOP dump_pose (utility::file::FileName const &filename, JobCOP job, core::pose::Pose const &pose, bool bWriteScoreOnly, int copy_count=-1)

Detailed Description

this is a implementation of JobOutputter for silent-file-based output.


Member Typedef Documentation

Reimplemented from protocols::jd2::FileJobOutputter.


Constructor & Destructor Documentation

protocols::jd2::SilentFileJobOutputter::SilentFileJobOutputter ( )
protocols::jd2::SilentFileJobOutputter::~SilentFileJobOutputter ( ) [virtual]

Member Function Documentation

core::io::silent::SilentStructOP protocols::jd2::SilentFileJobOutputter::dump_pose ( utility::file::FileName const &  filename,
JobCOP  job,
core::pose::Pose const &  pose,
bool  bWriteScoreOnly,
int  copy_count = -1 
) [protected]
virtual std::string protocols::jd2::SilentFileJobOutputter::filename ( JobCOP  ) const [inline, virtual]

Reimplemented from protocols::jd2::JobOutputter.

Referenced by other_pose().

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

this function outputs the final result of a job.

creating output functions/////////////////////////////////////////

Implements protocols::jd2::FileJobOutputter.

References dump_pose(), protocols::jd2::FileJobOutputter::scorefile_name(), and core::io::silent::SilentFileData::write_silent_struct().

void protocols::jd2::SilentFileJobOutputter::flush ( ) [virtual]

this function flushes any internal buffers - see parent class for explanation

Reimplemented from protocols::jd2::JobOutputter.

bool protocols::jd2::SilentFileJobOutputter::job_has_completed ( 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 core::sequence::end, output_name(), and core::scoring::pair.

void protocols::jd2::SilentFileJobOutputter::other_pose ( 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.

--->these go to file silent_filename+tag

Implements protocols::jd2::FileJobOutputter.

References dump_pose(), filename(), protocols::jd2::FileJobOutputter::scorefile_name(), and core::io::silent::SilentFileData::write_silent_struct().

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

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

SilentFile 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 dump_pose(), and job_has_completed().

void protocols::jd2::SilentFileJobOutputter::set_silent_file_name ( utility::file::FileName  name)
void protocols::jd2::SilentFileJobOutputter::set_write_no_structures ( bool  value = true) [inline]
void protocols::jd2::SilentFileJobOutputter::set_write_separate_scorefile ( bool  write_separate_scorefile)

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