Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::jd3::pose_outputters::SilentFilePoseOutputter Class Reference

The SilentFilePoseOutputter. More...

#include <SilentFilePoseOutputter.hh>

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

Public Member Functions

 SilentFilePoseOutputter ()
 
 ~SilentFilePoseOutputter () override
 
void determine_job_tag (utility::tag::TagCOP output_tag, utility::options::OptionCollection const &job_options, InnerLarvalJob &job) const override
 Determine the inner-larval job's "job_tag" from the <Output> tag / per-job options. More...
 
std::string outputter_for_job (utility::tag::TagCOP output_tag, utility::options::OptionCollection const &job_options, InnerLarvalJob const &job) const override
 
std::string outputter_for_job (PoseOutputSpecification const &spec) const override
 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...
 
bool job_has_already_completed (LarvalJob const &job, utility::options::OptionCollection const &options) const override
 
std::string filename_for_output_job (utility::tag::TagCOP outputter_tag, utility::options::OptionCollection const &job_options) const
 
PoseOutputSpecificationOP create_output_specification (LarvalJob const &job, JobOutputIndex const &output_index, utility::options::OptionCollection const &options, utility::tag::TagCOP tag) override
 Create the PoseOutputSpecification for a particular job. More...
 
void write_output (output::OutputSpecification const &spec, JobResult const &result) override
 Write a pose out to permanent storage (whatever that may be). More...
 
void flush () override
 Write out all cached silent files – may happen after an exception is caught by the JobDistributor and the process is about to be spun down. More...
 
std::string class_key () const override
 Return the string used by the SilentFilePoseOutputterCreator to identify the class in an XML file (which is the string returned by the static keyname method) More...
 
- Public Member Functions inherited from protocols::jd3::pose_outputters::PoseOutputter
 PoseOutputter ()
 
 ~PoseOutputter () override
 
- Public Member Functions inherited from protocols::jd3::output::ResultOutputter
 ResultOutputter ()
 
 ~ResultOutputter () override
 

Static Public Member Functions

static bool outputter_specified_by_command_line ()
 
static std::string keyname ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
static void list_options_read (utility::options::OptionKeyList &read_options)
 

Private Attributes

std::string fname_out_
 
core::Size buffer_limit_
 
core::io::silent::SilentFileOptionsOP opts_
 
utility::vector1
< core::io::silent::SilentStructOP
buffered_structs_
 

Detailed Description

The SilentFilePoseOutputter.

Constructor & Destructor Documentation

protocols::jd3::pose_outputters::SilentFilePoseOutputter::SilentFilePoseOutputter ( )
protocols::jd3::pose_outputters::SilentFilePoseOutputter::~SilentFilePoseOutputter ( )
overridedefault

Member Function Documentation

std::string protocols::jd3::pose_outputters::SilentFilePoseOutputter::class_key ( ) const
overridevirtual

Return the string used by the SilentFilePoseOutputterCreator to identify the class in an XML file (which is the string returned by the static keyname method)

Implements protocols::jd3::pose_outputters::PoseOutputter.

References keyname().

PoseOutputSpecificationOP protocols::jd3::pose_outputters::SilentFilePoseOutputter::create_output_specification ( LarvalJob const &  job,
JobOutputIndex const &  output_index,
utility::options::OptionCollection const &  options,
utility::tag::TagCOP  tag 
)
overridevirtual
void protocols::jd3::pose_outputters::SilentFilePoseOutputter::determine_job_tag ( utility::tag::TagCOP  output_tag,
utility::options::OptionCollection const &  job_options,
InnerLarvalJob job 
) const
overridevirtual

Determine the inner-larval job's "job_tag" from the <Output> tag / per-job options.

Implements protocols::jd3::pose_outputters::PoseOutputter.

References protocols::jd3::InnerLarvalJob::input_tag(), and protocols::jd3::InnerLarvalJob::job_tag().

std::string protocols::jd3::pose_outputters::SilentFilePoseOutputter::filename_for_output_job ( utility::tag::TagCOP  outputter_tag,
utility::options::OptionCollection const &  job_options 
) const
void protocols::jd3::pose_outputters::SilentFilePoseOutputter::flush ( )
overridevirtual

Write out all cached silent files – may happen after an exception is caught by the JobDistributor and the process is about to be spun down.

Implements protocols::jd3::output::ResultOutputter.

References core::io::silent::SilentFileData::add_structure(), buffered_structs_, fname_out_, opts_, and core::io::silent::SilentFileData::write_all().

Referenced by write_output().

bool protocols::jd3::pose_outputters::SilentFilePoseOutputter::job_has_already_completed ( LarvalJob const &  job,
utility::options::OptionCollection const &  options 
) const
overridevirtual
std::string protocols::jd3::pose_outputters::SilentFilePoseOutputter::keyname ( )
static
void protocols::jd3::pose_outputters::SilentFilePoseOutputter::list_options_read ( utility::options::OptionKeyList &  read_options)
static
std::string protocols::jd3::pose_outputters::SilentFilePoseOutputter::outputter_for_job ( utility::tag::TagCOP  outputter_tag,
utility::options::OptionCollection const &  opts,
InnerLarvalJob const &  job 
) const
overridevirtual

If this is just being given an InnerLarvalJob, that means that the outputter is at most a function of the input source–as there's a bijection b/n ILJ and input source. So, let's just use the job_tag. What else can we do?

Implements protocols::jd3::pose_outputters::PoseOutputter.

References filename_for_output_job().

std::string protocols::jd3::pose_outputters::SilentFilePoseOutputter::outputter_for_job ( PoseOutputSpecification const &  spec) const
overridevirtual

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.

Implements protocols::jd3::pose_outputters::PoseOutputter.

bool protocols::jd3::pose_outputters::SilentFilePoseOutputter::outputter_specified_by_command_line ( )
static
void protocols::jd3::pose_outputters::SilentFilePoseOutputter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::jd3::pose_outputters::SilentFilePoseOutputter::write_output ( output::OutputSpecification const &  spec,
JobResult const &  result 
)
overridevirtual

Member Data Documentation

core::Size protocols::jd3::pose_outputters::SilentFilePoseOutputter::buffer_limit_
private

Referenced by write_output().

utility::vector1< core::io::silent::SilentStructOP > protocols::jd3::pose_outputters::SilentFilePoseOutputter::buffered_structs_
private

Referenced by flush(), and write_output().

std::string protocols::jd3::pose_outputters::SilentFilePoseOutputter::fname_out_
private

Referenced by flush(), and write_output().

core::io::silent::SilentFileOptionsOP protocols::jd3::pose_outputters::SilentFilePoseOutputter::opts_
private

Referenced by flush(), and write_output().


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