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

The PoseInputter is responsible for reading from the command line a set of structures that are each to be run through a protocol, where each input struture will be the starting point for some number of jobs (where that number is at the JobQueen's discretion). The PoseInputter is responsible for two things: More...

#include <PoseInputter.hh>

Inheritance diagram for protocols::jd3::pose_inputters::PoseInputter:
Inheritance graph
[legend]

Public Member Functions

 PoseInputter ()
 
 ~PoseInputter () override
 
virtual bool job_available_on_command_line () const =0
 
virtual PoseInputSources pose_input_sources_from_command_line ()=0
 Construct a list of PoseInputSource objects from the command line that will be used by the JobQueen to construct a list of LarvalJobs. More...
 
virtual PoseInputSources pose_input_sources_from_tag (utility::options::OptionCollection const &opts, utility::tag::TagCOP)=0
 Construct a list of PoseInputSource objects from a Tag object that will be used by the JobQueen to construct a list of LarvalJobs. More...
 
virtual core::pose::PoseOP pose_from_input_source (PoseInputSource const &input_source, utility::options::OptionCollection const &options, utility::tag::TagCOP tag)=0
 Convert a single PoseInputSource into a Pose that will be used to initialize a Job. The PoseInputSource object must have originated from this PoseInputter in the prior call to initialize_pose_input_sources. More...
 

Detailed Description

The PoseInputter is responsible for reading from the command line a set of structures that are each to be run through a protocol, where each input struture will be the starting point for some number of jobs (where that number is at the JobQueen's discretion). The PoseInputter is responsible for two things:

In addition to the virtual functions, each derived PoseInputter should define two static methods that will be invoked by its corresponding PoseInputterCreator:

Constructor & Destructor Documentation

protocols::jd3::pose_inputters::PoseInputter::PoseInputter ( )
default
protocols::jd3::pose_inputters::PoseInputter::~PoseInputter ( )
overridedefault

Member Function Documentation

virtual bool protocols::jd3::pose_inputters::PoseInputter::job_available_on_command_line ( ) const
pure virtual
virtual core::pose::PoseOP protocols::jd3::pose_inputters::PoseInputter::pose_from_input_source ( PoseInputSource const &  input_source,
utility::options::OptionCollection const &  options,
utility::tag::TagCOP  tag 
)
pure virtual

Convert a single PoseInputSource into a Pose that will be used to initialize a Job. The PoseInputSource object must have originated from this PoseInputter in the prior call to initialize_pose_input_sources.

Implemented in protocols::jd3::pose_inputters::SilentFilePoseInputter, and protocols::jd3::pose_inputters::PDBPoseInputter.

virtual PoseInputSources protocols::jd3::pose_inputters::PoseInputter::pose_input_sources_from_command_line ( )
pure virtual

Construct a list of PoseInputSource objects from the command line that will be used by the JobQueen to construct a list of LarvalJobs.

Implemented in protocols::jd3::pose_inputters::PDBPoseInputter, and protocols::jd3::pose_inputters::SilentFilePoseInputter.

virtual PoseInputSources protocols::jd3::pose_inputters::PoseInputter::pose_input_sources_from_tag ( utility::options::OptionCollection const &  opts,
utility::tag::TagCOP   
)
pure virtual

Construct a list of PoseInputSource objects from a Tag object that will be used by the JobQueen to construct a list of LarvalJobs.

Implemented in protocols::jd3::pose_inputters::PDBPoseInputter, and protocols::jd3::pose_inputters::SilentFilePoseInputter.


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