Rosetta Protocols  2014.35
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
protocols::jd2::JobInputter Class Referenceabstract

#include <JobInputter.hh>

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. More...
 
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". More...
 
virtual
JobInputterInputSource::Enum 
input_source () const =0
 return the type of input source that the JobInputter is currently using More...
 

Static Public Member Functions

static std::string job_inputter_input_source_to_string (JobInputterInputSource::Enum source)
 call this with input_source() to get the input source of a particular job inputter More...
 

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. More...
 
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. More...
 
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) More...
 

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::jd2::JD2ResourceManagerJobInputter, protocols::features::DatabaseJobInputter, protocols::jd2::BatchJobInputter, protocols::jd2::SilentFileJobInputter, protocols::comparative_modeling::ThreadingJobInputter, protocols::jd2::AtomTreeDiffJobInputter, protocols::comparative_modeling::GenericJobInputter, protocols::make_rot_lib::MakeRotLibJobInputter, protocols::jd2::PDBJobInputter, protocols::jd2::PoseInputStreamJobInputter, protocols::jd2::ScreeningJobInputter, and protocols::jd2::LazySilentFileJobInputter.

core::Size protocols::jd2::JobInputter::get_nstruct ( ) const
protectedvirtual
virtual JobInputterInputSource::Enum protocols::jd2::JobInputter::input_source ( ) const
pure virtual
std::string protocols::jd2::JobInputter::job_inputter_input_source_to_string ( JobInputterInputSource::Enum  source)
static
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)

References protocols::jd2::Job::inner_job_nonconst().

Referenced by protocols::jd2::ScreeningJobInputter::pose_from_job(), protocols::enzdes::EnzdesJobInputter::pose_from_job(), protocols::make_rot_lib::MakeRotLibJobInputter::pose_from_job(), and protocols::jd2::JD2ResourceManagerJobInputter::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)

References protocols::jd2::Job::inner_job_nonconst().

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

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