Rosetta 3.4
Public Member Functions | Protected Member Functions
protocols::jd2::JobInputter Class Reference

#include <JobInputter.hh>

Inheritance diagram for protocols::jd2::JobInputter:
Inheritance graph
[legend]
Collaboration diagram for protocols::jd2::JobInputter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~JobInputter ()
virtual void pose_from_job (core::pose::Pose &pose, JobOP job)=0
 this function is responsible for filling the pose reference with the pose indicated by the job. The Job object (within its InnerJob) contains a PoseCOP. This function needs to either fill the pose reference from the InnerJob or, on first demand of a pose from that InnerJob, instantiate the pose, hand off a COP to the InnerJob, and fill the reference.
virtual void fill_jobs (Jobs &jobs)=0
 this function determines what jobs exist. This function neither knows nor cares what jobs are already complete on disk/memory - it just figures out what ones should exist given the input. NOTE: your JobInputter should order Job objects in the Jobs vector to have as few "transitions" between inputs as possible (group all Jobs of the same input next to each other). This improves efficiency of the "FAIL_BAD_INPUT" functionality. Note I said "should", not "must".
virtual
JobInputterInputSource::Enum 
input_source () const =0
 return the type of input source that the JobInputter is currently using

Protected Member Functions

void load_pose_into_job (core::pose::Pose const &pose, JobOP job)
 this function modifies the InnerJob's pose. Access to that pose is via friendship.
void load_pose_into_job (core::pose::PoseCOP pose, JobOP job)
 this function modifies the InnerJob's pose. Access to that pose is via friendship.
virtual core::Size get_nstruct () const
 this code is here to restrict the use of inner_job_nonconst (this class is a friend class and can do it)

Detailed Description

the JobInputter class is responsible for A) determining what jobs exist, and B) taking a job object and returning the starting pose associated with that job. NOTE: your JobInputter should order Job objects in the Jobs vector to have as few "transitions" between inputs as possible (group all Jobs of the same input next to each other). This improves efficiency of the "FAIL_BAD_INPUT" functionality. I said "should", not "must" on purpose.


Constructor & Destructor Documentation

protocols::jd2::JobInputter::~JobInputter ( ) [virtual]

Member Function Documentation

virtual void protocols::jd2::JobInputter::fill_jobs ( Jobs jobs) [pure virtual]

this function determines what jobs exist. This function neither knows nor cares what jobs are already complete on disk/memory - it just figures out what ones should exist given the input. NOTE: your JobInputter should order Job objects in the Jobs vector to have as few "transitions" between inputs as possible (group all Jobs of the same input next to each other). This improves efficiency of the "FAIL_BAD_INPUT" functionality. Note I said "should", not "must".

Implemented in protocols::comparative_modeling::GenericJobInputter, protocols::comparative_modeling::ThreadingJobInputter, protocols::features::DatabaseJobInputter, protocols::jd2::AtomTreeDiffJobInputter, protocols::jd2::BatchJobInputter, protocols::jd2::LazySilentFileJobInputter, protocols::jd2::PDBJobInputter, protocols::jd2::PoseInputStreamJobInputter, and protocols::jd2::SilentFileJobInputter.

core::Size protocols::jd2::JobInputter::get_nstruct ( ) const [protected, virtual]

this code is here to restrict the use of inner_job_nonconst (this class is a friend class and can do it)

Referenced by protocols::features::DatabaseJobInputter::fill_jobs(), protocols::comparative_modeling::ThreadingJobInputter::fill_jobs(), and protocols::comparative_modeling::GenericJobInputter::fill_jobs().

virtual JobInputterInputSource::Enum protocols::jd2::JobInputter::input_source ( ) const [pure virtual]
void protocols::jd2::JobInputter::load_pose_into_job ( core::pose::Pose const &  pose,
JobOP  job 
) [protected]

this function modifies the InnerJob's pose. Access to that pose is via friendship.

this code is here to restrict the use of inner_job_nonconst (this class is a friend class and can do it)

Referenced by protocols::enzdes::EnzdesJobInputter::pose_from_job().

void protocols::jd2::JobInputter::load_pose_into_job ( core::pose::PoseCOP  pose,
JobOP  job 
) [protected]

this function modifies the InnerJob's pose. Access to that pose is via friendship.

this code is here to restrict the use of inner_job_nonconst (this class is a friend class and can do it)

virtual void protocols::jd2::JobInputter::pose_from_job ( core::pose::Pose pose,
JobOP  job 
) [pure virtual]

this function is responsible for filling the pose reference with the pose indicated by the job. The Job object (within its InnerJob) contains a PoseCOP. This function needs to either fill the pose reference from the InnerJob or, on first demand of a pose from that InnerJob, instantiate the pose, hand off a COP to the InnerJob, and fill the reference.

Implemented in protocols::comparative_modeling::GenericJobInputter, protocols::comparative_modeling::ThreadingJobInputter, protocols::enzdes::EnzdesJobInputter, protocols::features::DatabaseJobInputter, protocols::jd2::AtomTreeDiffJobInputter, protocols::jd2::BatchJobInputter, protocols::jd2::LazySilentFileJobInputter, protocols::jd2::PDBJobInputter, protocols::jd2::PoseInputStreamJobInputter, protocols::jd2::SilentFileJobInputter, and protocols::protein_interface_design::ParserJobInputter.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines