Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
protocols::jd3::pose_outputters::PoseOutputter Class Referenceabstract

The PoseOutputter. More...

#include <PoseOutputter.hh>

Inheritance diagram for protocols::jd3::pose_outputters::PoseOutputter:
Inheritance graph
[legend]

Public Member Functions

 PoseOutputter ()
 
 ~PoseOutputter () override
 
virtual void determine_job_tag (utility::tag::TagCOP output_tag, utility::options::OptionCollection const &job_options, InnerLarvalJob &job) const =0
 Determine the inner-larval job's "job_tag" from the <Output> tag / per-job options. More...
 
virtual std::string class_key () const =0
 Return the stiring used to identify this class. More...
 
virtual std::string outputter_for_job (utility::tag::TagCOP outputter_tag, utility::options::OptionCollection const &job_options, InnerLarvalJob const &job) const =0
 Return an identifier string for the specific instance of the PoseOutputter that ought to be used for a particular job so that the PoseOutputter can e.g. aggregate all of the outputs for a group of jobs and output them all at once when flush is called. The outputter may return the empty string if all outputters (of the same type) are interchangable (e.g. the PDBPoseOutputter). e.g., the SilentFilePoseOutputter returns the name of the file that it sends its outputs to. More...
 
virtual std::string outputter_for_job (PoseOutputSpecification const &spec) const =0
 Return an identifier string for the specific instance of the PoseOutputter that ought to be used for a particular job so that the PoseOutputter can e.g. aggregate all of the outputs for a group of jobs and output them all at once when flush is called. The outputter may return the empty string if all outputters (of the same type) are interchangable (e.g. the PDBPoseOutputter). e.g., the SilentFilePoseOutputter returns the name of the file that it sends its outputs to. This function respects the output-filename-suffix that may have been provided by the JobDistributor. More...
 
virtual bool job_has_already_completed (LarvalJob const &job, utility::options::OptionCollection const &options) const =0
 
virtual PoseOutputSpecificationOP create_output_specification (LarvalJob const &job, JobOutputIndex const &output_index, utility::options::OptionCollection const &options, utility::tag::TagCOP outputter_tag)=0
 Create the PoseOutputSpecification for a particular job. More...
 
- Public Member Functions inherited from protocols::jd3::output::ResultOutputter
 ResultOutputter ()
 
 ~ResultOutputter () override
 
virtual void write_output (OutputSpecification const &specification, JobResult const &result)=0
 
virtual void flush ()=0
 Output from an outputter may be held back and only flushed when requested by the JobQueen; I/O can be expensive, so it's a good idea to gather up the results of many outputs before flushing them to disk. More...
 

Detailed Description

The PoseOutputter.

Constructor & Destructor Documentation

protocols::jd3::pose_outputters::PoseOutputter::PoseOutputter ( )
default
protocols::jd3::pose_outputters::PoseOutputter::~PoseOutputter ( )
overridedefault

Member Function Documentation

virtual std::string protocols::jd3::pose_outputters::PoseOutputter::class_key ( ) const
pure virtual
virtual PoseOutputSpecificationOP protocols::jd3::pose_outputters::PoseOutputter::create_output_specification ( LarvalJob const &  job,
JobOutputIndex const &  output_index,
utility::options::OptionCollection const &  options,
utility::tag::TagCOP  outputter_tag 
)
pure virtual
virtual void protocols::jd3::pose_outputters::PoseOutputter::determine_job_tag ( utility::tag::TagCOP  output_tag,
utility::options::OptionCollection const &  job_options,
InnerLarvalJob job 
) const
pure virtual
virtual bool protocols::jd3::pose_outputters::PoseOutputter::job_has_already_completed ( LarvalJob const &  job,
utility::options::OptionCollection const &  options 
) const
pure virtual
virtual std::string protocols::jd3::pose_outputters::PoseOutputter::outputter_for_job ( utility::tag::TagCOP  outputter_tag,
utility::options::OptionCollection const &  job_options,
InnerLarvalJob const &  job 
) const
pure virtual

Return an identifier string for the specific instance of the PoseOutputter that ought to be used for a particular job so that the PoseOutputter can e.g. aggregate all of the outputs for a group of jobs and output them all at once when flush is called. The outputter may return the empty string if all outputters (of the same type) are interchangable (e.g. the PDBPoseOutputter). e.g., the SilentFilePoseOutputter returns the name of the file that it sends its outputs to.

Implemented in protocols::jd3::pose_outputters::DeNovoSilentFilePoseOutputter, protocols::jd3::pose_outputters::SilentFilePoseOutputter, protocols::jd3::pose_outputters::PDBPoseOutputter, and protocols::jd3::pose_outputters::ScoreFileOutputter.

virtual std::string protocols::jd3::pose_outputters::PoseOutputter::outputter_for_job ( PoseOutputSpecification const &  spec) const
pure virtual

Return an identifier string for the specific instance of the PoseOutputter that ought to be used for a particular job so that the PoseOutputter can e.g. aggregate all of the outputs for a group of jobs and output them all at once when flush is called. The outputter may return the empty string if all outputters (of the same type) are interchangable (e.g. the PDBPoseOutputter). e.g., the SilentFilePoseOutputter returns the name of the file that it sends its outputs to. This function respects the output-filename-suffix that may have been provided by the JobDistributor.

Implemented in protocols::jd3::pose_outputters::DeNovoSilentFilePoseOutputter, protocols::jd3::pose_outputters::SilentFilePoseOutputter, protocols::jd3::pose_outputters::PDBPoseOutputter, and protocols::jd3::pose_outputters::ScoreFileOutputter.


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