protocols::jd3::pose_inputters::PoseInputter Class Reference

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:

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:

• for creating a list of PoseInputSource objects

• for turning a PoseInputSource object into a Pose on demand.

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

• static std::string keyname();
• static void provide_xml_schema( utility::tag::XMLSchemaDefinition & xsd );

Constructor & Destructor Documentation

PoseInputter()

protocols::jd3::pose_inputters::PoseInputter::PoseInputter ( )

default

~PoseInputter()

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

overridedefault

Member Function Documentation

job_available_on_command_line()

virtual bool protocols::jd3::pose_inputters::PoseInputter::job_available_on_command_line ( ) const

pure virtual

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

pose_from_input_source()

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.

pose_input_sources_from_command_line()

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::SilentFilePoseInputter, and protocols::jd3::pose_inputters::PDBPoseInputter.

pose_input_sources_from_tag()

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::SilentFilePoseInputter, and protocols::jd3::pose_inputters::PDBPoseInputter.

---

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

• src/protocols/jd3/pose_inputters/PoseInputter.hh
• src/protocols/jd3/pose_inputters/PoseInputter.cc