Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
protocols::jd2::NoOutputJobOutputter Class Reference

#include <NoOutputJobOutputter.hh>

Inheritance diagram for protocols::jd2::NoOutputJobOutputter:
Inheritance graph
[legend]

Public Member Functions

 NoOutputJobOutputter ()
 
void file (JobCOP, std::string const &) override
 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...
 
void final_pose (JobOP, core::pose::Pose const &, std::string const &) override
 this function outputs the final result of a job. More...
 
void other_pose (JobOP, core::pose::Pose const &, std::string const &, int, bool) override
 this function is intended for saving mid-protocol poses; for example the final centroid structure in a combined centroid/fullatom protocol. More...
 
bool job_has_completed (JobCOP) override
 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...
 
std::string output_name (JobCOP job) override
 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 ()
 constructor – reads cmd-line to initialize evaluators More...
 
 ~JobOutputter () override
 
virtual void flush ()
 this function is meant to be redefined in child classes to allow for flushing of memory buffers. Here's the long version: The SilentFileJobOutputter wanted to buffer output, but needed to guaruntee that the output would be flushed at end of runtime. The original implementation was to A) bend over backward to ensure that the destructor was run (JobOutputter lives inside static JobDistributor, which was previously not destructed because it's static) and B) flush the buffers in the destructor. This caused a problem because the buffer-flushing tried to use the Tracers, which had already been destructed...boom crash. 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 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 generates the affixed, numbered name for the job as prefix + input + suffix + number (affixes from options system). This function is deliberately not virtual, this should be a common mechanism; your JobOutputter can not call it if it would like. More...
 

Detailed Description

the NoOutputJobOutputter class is responsible for NOT dealing with output

Constructor & Destructor Documentation

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

Member Function Documentation

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

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.

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

this function outputs the final result of a job.

Implements protocols::jd2::JobOutputter.

bool protocols::jd2::NoOutputJobOutputter::job_has_completed ( JobCOP  )
inlineoverridevirtual

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.

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

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.

std::string protocols::jd2::NoOutputJobOutputter::output_name ( JobCOP  job)
inlineoverridevirtual

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: