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

The mmTFPoseOutputter. More...

#include <mmTFPoseOutputter.hh>

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

Public Member Functions

 mmTFPoseOutputter ()
 
 ~mmTFPoseOutputter () override
 
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 &specification, JobResult const &result) override
 Write a pose out to permanent storage (whatever that may be). More...
 
std::string class_key () const override
 Return the stiring used to identify this class. More...
 
std::string output_name (LarvalJob const &job, JobOutputIndex const &output_index, utility::options::OptionCollection const &options, utility::tag::TagCOP tag) const override
 
- Public Member Functions inherited from protocols::jd3::pose_outputters::PDBPoseOutputter
 PDBPoseOutputter ()
 
 ~PDBPoseOutputter () 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
 
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 &specification, JobResult const &result) override
 Write a pose out to permanent storage (whatever that may be). More...
 
void flush () override
 Currently a no-op since the "write output pose" method sends all outputs to disk. More...
 
std::string class_key () const override
 Return the stiring used by the PDBPoseOutputterCreator for this class. More...
 
virtual std::string output_name (LarvalJob const &job, utility::options::OptionCollection const &options, utility::tag::TagCOP tag) const
 Guess on the name of the output PDB using just the LarvalJob – i.e. in the absence of the JobOutputIndex. 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)
 
- Static Public Member Functions inherited from protocols::jd3::pose_outputters::PDBPoseOutputter
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)
 

Detailed Description

The mmTFPoseOutputter.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Return the stiring used to identify this class.

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

References keyname().

PoseOutputSpecificationOP protocols::jd3::pose_outputters::mmTFPoseOutputter::create_output_specification ( LarvalJob const &  job,
JobOutputIndex const &  output_index,
utility::options::OptionCollection const &  options,
utility::tag::TagCOP  tag 
)
overridevirtual

Create the PoseOutputSpecification for a particular job.

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

References output_name().

std::string protocols::jd3::pose_outputters::mmTFPoseOutputter::keyname ( )
static
void protocols::jd3::pose_outputters::mmTFPoseOutputter::list_options_read ( utility::options::OptionKeyList &  read_options)
static
std::string protocols::jd3::pose_outputters::mmTFPoseOutputter::output_name ( LarvalJob const &  job,
JobOutputIndex const &  output_index,
utility::options::OptionCollection const &  options,
utility::tag::TagCOP  tag 
) const
overridevirtual
bool protocols::jd3::pose_outputters::mmTFPoseOutputter::outputter_specified_by_command_line ( )
static
void protocols::jd3::pose_outputters::mmTFPoseOutputter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::jd3::pose_outputters::mmTFPoseOutputter::write_output ( output::OutputSpecification const &  specification,
JobResult const &  result 
)
overridevirtual

Write a pose out to permanent storage (whatever that may be).

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

References core::io::mmtf::dump_mmtf().


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