protocols::jd3::full_model_inputters::FullModelInputter Class Reference

The FullModelInputter 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 FullModelInputter is responsible for two things: More...

#include <FullModelInputter.hh>

Inheritance diagram for protocols::jd3::full_model_inputters::FullModelInputter:

Public Member Functions
	FullModelInputter ()
	~FullModelInputter () override
virtual bool	job_available_on_command_line () const =0
virtual FullModelInputSources	full_model_input_sources_from_command_line ()=0
	Construct a list of FullModelInputSource objects from the command line that will be used by the JobQueen to construct a list of LarvalJobs. More...
virtual FullModelInputSources	full_model_input_sources_from_tag (utility::options::OptionCollection const &opts, utility::tag::TagCOP)=0
	Construct a list of FullModelInputSource objects from a Tag object that will be used by the JobQueen to construct a list of LarvalJobs. More...
virtual core::pose::PoseOP	full_model_from_input_source (FullModelInputSource const &input_source, utility::options::OptionCollection const &options, utility::tag::TagCOP tag)=0
	Convert a single FullModelInputSource into a Pose that will be used to initialize a Job. The FullModelInputSource object must have originated from this FullModelInputter in the prior call to initialize_full_model_input_sources. More...

Detailed Description

The FullModelInputter 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 FullModelInputter is responsible for two things:

• for creating a list of FullModelInputSource objects
• for turning a FullModelInputSource object into a Pose on demand.

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

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

Constructor & Destructor Documentation

protocols::jd3::full_model_inputters::FullModelInputter::FullModelInputter ( )

default

protocols::jd3::full_model_inputters::FullModelInputter::~FullModelInputter ( )

overridedefault

Member Function Documentation

virtual core::pose::PoseOP protocols::jd3::full_model_inputters::FullModelInputter::full_model_from_input_source ( FullModelInputSource const &  input_source, utility::options::OptionCollection const &  options, utility::tag::TagCOP  tag  )

pure virtual

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

Implemented in protocols::jd3::full_model_inputters::SilentFileFullModelInputter, and protocols::jd3::full_model_inputters::PDBFullModelInputter.

virtual FullModelInputSources protocols::jd3::full_model_inputters::FullModelInputter::full_model_input_sources_from_command_line ( )

pure virtual

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

Implemented in protocols::jd3::full_model_inputters::SilentFileFullModelInputter, and protocols::jd3::full_model_inputters::PDBFullModelInputter.

virtual FullModelInputSources protocols::jd3::full_model_inputters::FullModelInputter::full_model_input_sources_from_tag ( utility::options::OptionCollection const &  opts, utility::tag::TagCOP    )

pure virtual

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

Implemented in protocols::jd3::full_model_inputters::SilentFileFullModelInputter, and protocols::jd3::full_model_inputters::PDBFullModelInputter.

virtual bool protocols::jd3::full_model_inputters::FullModelInputter::job_available_on_command_line ( ) const

pure virtual

Implemented in protocols::jd3::full_model_inputters::SilentFileFullModelInputter, and protocols::jd3::full_model_inputters::PDBFullModelInputter.

---

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

• src/protocols/jd3/full_model_inputters/FullModelInputter.hh
• src/protocols/jd3/full_model_inputters/FullModelInputter.cc