Rosetta Protocols  2014.35
Public Member Functions | List of all members
protocols::jd2::NoOutputJobOutputter Class Reference

#include <NoOutputJobOutputter.hh>

Public Member Functions

 NoOutputJobOutputter ()
 
virtual void file (JobCOP, std::string const &)
 this function takes a string and writes it to disk (separately from Tracer output). use some sort of extention option system - default .dat? .data? More...
 
virtual void final_pose (JobOP, core::pose::Pose const &, std::string const &)
 this function outputs the final result of a job. More...
 
virtual void other_pose (JobOP, core::pose::Pose const &, std::string const &, int, bool)
 this function is intended for saving mid-protocol poses; for example the final centroid structure in a combined centroid/fullatom protocol. More...
 
virtual bool job_has_completed (JobCOP)
 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. More...
 
virtual std::string output_name (JobCOP job)
 this is the master function for determining the unique output identifier for a job - should this be defined in the base class? More...
 
- Public Member Functions inherited from protocols::jd2::JobOutputter
 JobOutputter ()
 
virtual ~JobOutputter ()
 
virtual void flush ()
 this function is meant to be redefined in child classes to allow for flushing of memory buffers. More...
 
virtual void starting_pose (core::pose::Pose const &)
 optionally pass a starting (reference) pose to a JobOutputter for later comparison purposes and/or as interface for initializing evaluators More...
 
virtual std::string filename (JobCOP) const
 
void add_evaluation (evaluation::PoseEvaluatorOP)
 
void set_evaluators (evaluation::PoseEvaluators const &)
 
void clear_evaluators ()
 clear the list of evaluators More...
 
evaluation::PoseEvaluatorsCOP evaluators () const
 
void evaluate (core::pose::Pose &pose, std::string tag, core::io::silent::SilentStruct &pss) const
 
void call_output_observers (core::pose::Pose const &pose, JobOP job) const
 call all output_observers More...
 
void add_output_observer (JobOutputterObserverAP an_observer)
 
void remove_output_observer (JobOutputterObserverAP old_observer)
 
void set_defaults ()
 clear the list of evaluators More...
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::jd2::JobOutputter
std::string affixed_numbered_name (JobCOP job)
 this function provides the extended name, not just the output name. e.g output_name returns 1UBQ_0001, this returns 1UBQ_0001.pdb More...
 

Detailed Description

the NoOutputJobOutputter class is responsible for NOT dealing with output

Constructor & Destructor Documentation

protocols::jd2::NoOutputJobOutputter::NoOutputJobOutputter ( )
inline

Member Function Documentation

virtual void protocols::jd2::NoOutputJobOutputter::file ( JobCOP  ,
std::string const &   
)
inlinevirtual

this function takes a string and writes it to disk (separately from Tracer output). use some sort of extention option system - default .dat? .data?

Implements protocols::jd2::JobOutputter.

virtual void protocols::jd2::NoOutputJobOutputter::final_pose ( JobOP  ,
core::pose::Pose const &  ,
std::string const &   
)
inlinevirtual

this function outputs the final result of a job.

Implements protocols::jd2::JobOutputter.

virtual bool protocols::jd2::NoOutputJobOutputter::job_has_completed ( JobCOP  )
inlinevirtual

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::JobOutputter.

virtual void protocols::jd2::NoOutputJobOutputter::other_pose ( JobOP  ,
core::pose::Pose const &  ,
std::string const &  ,
int  ,
bool   
)
inlinevirtual

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

Implements protocols::jd2::JobOutputter.

virtual std::string protocols::jd2::NoOutputJobOutputter::output_name ( JobCOP  job)
inlinevirtual

this is the master function for determining the unique output identifier for a job - should this be defined in the base class?

Implements protocols::jd2::JobOutputter.

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


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