#include <BatchJobInputter.hh>

Inheritance diagram for protocols::jd2::BatchJobInputter:

Public Member Functions
	BatchJobInputter (std::string batch)

	~BatchJobInputter () override

void	pose_from_job (core::pose::Pose &pose, JobOP job) override
	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. This implementation uses pose_from_pdb More...

void	fill_jobs (JobsContainer &jobs) override
	this function determines what jobs exist from -in::file::silent and -in::file::tags. More...

JobInputterInputSource::Enum	input_source () const override
	Return the type of input source that the BatchJobInputter is currently using. More...

Public Member Functions inherited from protocols::jd2::JobInputter
	~JobInputter () override

JobInputterCOP	get_self_ptr () const
	Get self const owning pointers. More...

JobInputterOP	get_self_ptr ()
	Get self owning pointers. More...

JobInputterCAP	get_self_weak_ptr () const
	Get self const weak pointers. More...

JobInputterAP	get_self_weak_ptr ()
	Get self weak pointers. More...

virtual void	update_jobs_list (JobsContainerOP jobs)
	This function is only called by certain JobInputters to update the jobs list after it has already been created. More...

virtual bool	updates_jobs_list () const
	Does this type of JobInputter update the jobs list? More...

Static Public Attributes
static std::string const	BOGUS_BATCH_ID

Private Member Functions
void	read_batch ()

void	check_batch ()

Private Attributes
std::string	current_batch_

JobInputterOP	this_batch_job_inputter_

utility::options::OptionCollection const	vanilla_options_

Additional Inherited Members
Static Public Member Functions inherited from protocols::jd2::JobInputter
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 inherited from protocols::jd2::JobInputter
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

This is the simplest implementation of JobInputter, which reads from -s/-l and Batch files.

Constructor & Destructor Documentation

protocols::jd2::BatchJobInputter::BatchJobInputter ( std::string batch )

References BOGUS_BATCH_ID, protocols::jd2::JobDistributorFactory::create_job_inputter(), current_batch_, read_batch(), this_batch_job_inputter_, and protocols::jd2::tr().

protocols::jd2::BatchJobInputter::~BatchJobInputter ( )

override

References vanilla_options_.

Member Function Documentation

void protocols::jd2::BatchJobInputter::check_batch ( )

private

References current_batch_, protocols::jd2::JobDistributor::get_current_batch(), protocols::jd2::JobDistributor::get_instance(), and read_batch().

Referenced by fill_jobs(), and pose_from_job().

void protocols::jd2::BatchJobInputter::fill_jobs ( JobsContainer & jobs )

inlineoverridevirtual

this function determines what jobs exist from -in::file::silent and -in::file::tags.

Implements protocols::jd2::JobInputter.

References check_batch(), and this_batch_job_inputter_.

JobInputterInputSource::Enum protocols::jd2::BatchJobInputter::input_source ( ) const

overridevirtual

Return the type of input source that the BatchJobInputter is currently using.

Returns: The input source for the current batch.

Implements protocols::jd2::JobInputter.

References this_batch_job_inputter_.

void protocols::jd2::BatchJobInputter::pose_from_job	(	core::pose::Pose &	pose,
		JobOP	job
	)

inlineoverridevirtual

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. This implementation uses pose_from_pdb

Implements protocols::jd2::JobInputter.

References check_batch(), and this_batch_job_inputter_.

void protocols::jd2::BatchJobInputter::read_batch ( )

private

References protocols::jd2::JobDistributorFactory::create_job_inputter(), current_batch_, this_batch_job_inputter_, and vanilla_options_.

Referenced by BatchJobInputter(), and check_batch().