protocols::jd3::standard::MoverAndPoseJob Class Reference

#include <MoverAndPoseJob.hh>

Inheritance diagram for protocols::jd3::standard::MoverAndPoseJob:

Public Member Functions
	MoverAndPoseJob ()
	~MoverAndPoseJob () override
virtual CompletedJobOutput	run () override
	This is the main function of the Job object. It will be invoked by the JobDistributor. The Job will return a JobResult at the conclusion of its execution, and the JobResult will be serialized and sent to the appropriate JobQueen for processing and output. The Job itself will be discarded. Large constant data that might be shared between multiple jobs can be held by the Job object (or by classes that the Job object holds) but that data should not be put into the JobResult – large data should not be repeatedly serialized and shipped between nodes. More...
void	mover (moves::MoverOP setting)
void	pose (core::pose::PoseOP setting)
moves::MoverOP	mover ()
core::pose::PoseOP	pose ()
core::pose::PoseCOP	pose () const
Public Member Functions inherited from protocols::jd3::Job
	Job ()
	~Job () override

Protected Member Functions
virtual PoseJobResultOP	create_job_result ()
	Factory method so derived classes can return their own result classes, which themselves should derive from PoseJobResult. More...
virtual EnergyJobSummaryOP	create_job_summary ()
virtual void	finalize_job_result (PoseJobResultOP result)
	Method that allows derived classes to tuck data into the result object as they see fit. Noop in the base class. More...
virtual void	finalize_job_summary (EnergyJobSummaryOP summary)
	Method that allows derived classes to tuck data into the job summary object as they see fit. Noop in the base class. More...

Private Attributes
moves::MoverOP	mover_
core::pose::PoseOP	pose_

Constructor & Destructor Documentation

protocols::jd3::standard::MoverAndPoseJob::MoverAndPoseJob ( )

default

protocols::jd3::standard::MoverAndPoseJob::~MoverAndPoseJob ( )

overridedefault

Member Function Documentation

PoseJobResultOP protocols::jd3::standard::MoverAndPoseJob::create_job_result ( )

protectedvirtual

Factory method so derived classes can return their own result classes, which themselves should derive from PoseJobResult.

Referenced by run().

EnergyJobSummaryOP protocols::jd3::standard::MoverAndPoseJob::create_job_summary ( )

protectedvirtual

Referenced by run().

void protocols::jd3::standard::MoverAndPoseJob::finalize_job_result ( PoseJobResultOP  result )

protectedvirtual

Method that allows derived classes to tuck data into the result object as they see fit. Noop in the base class.

Template method invoked by the base class during result preparation and finalization. The derived MoverAndPoseJob class is encouraged to stash any additional information in some possible derived PoseJobResult class. This is invoked once per Pose returned by the Mover – multiple poses may be returned using Mover's get_additional_output method. The derived MoverAndPoseJob may look at each Pose by calling the pose() method: that is, the pose() method will return the pose that corresponds to a particular PoseJobResult that's being prepared. It is also already stored in the PoseJobResult.

Referenced by run().

void protocols::jd3::standard::MoverAndPoseJob::finalize_job_summary ( EnergyJobSummaryOP  summary )

protectedvirtual

Method that allows derived classes to tuck data into the job summary object as they see fit. Noop in the base class.

Template method invoked by the base class during result preparation and finalization. The derived MoverAndPoseJob class is encouraged to stash any additional information in some possible derived EnergyJobSummary class. This is invoked once per Pose returned by the Mover – multiple poses may be returned using Mover's get_additional_output method. The derived MoverAndPoseJob may look at each Pose by calling the pose() method: that is, the pose() method will return the pose that corresponds to a particular EnergyJobSummary that's being prepared.

Referenced by run().

void protocols::jd3::standard::MoverAndPoseJob::mover

(

moves::MoverOP

setting

)

References mover_.

moves::MoverOP protocols::jd3::standard::MoverAndPoseJob::mover

(

)

References mover_.

void protocols::jd3::standard::MoverAndPoseJob::pose

(

core::pose::PoseOP

setting

)

References pose_.

core::pose::PoseOP protocols::jd3::standard::MoverAndPoseJob::pose

(

)

References pose_.

core::pose::PoseCOP protocols::jd3::standard::MoverAndPoseJob::pose

(

)

const

References pose_.

CompletedJobOutput protocols::jd3::standard::MoverAndPoseJob::run ( )

overridevirtual

This is the main function of the Job object. It will be invoked by the JobDistributor. The Job will return a JobResult at the conclusion of its execution, and the JobResult will be serialized and sent to the appropriate JobQueen for processing and output. The Job itself will be discarded. Large constant data that might be shared between multiple jobs can be held by the Job object (or by classes that the Job object holds) but that data should not be put into the JobResult – large data should not be repeatedly serialized and shipped between nodes.

Implements protocols::jd3::Job.

References create_job_result(), create_job_summary(), protocols::moves::FAIL, protocols::moves::FAIL_BAD_INPUT, protocols::moves::FAIL_DO_NOT_RETRY, protocols::moves::FAIL_RETRY, finalize_job_result(), finalize_job_summary(), protocols::jd3::jd3_job_status_failed_do_not_retry, protocols::jd3::jd3_job_status_failed_retry, protocols::jd3::jd3_job_status_inputs_were_bad, protocols::jd3::jd3_job_status_success, mover_, protocols::moves::MS_SUCCESS, pose_, and protocols::jd3::CompletedJobOutput::status.

Member Data Documentation

moves::MoverOP protocols::jd3::standard::MoverAndPoseJob::mover_

private

Referenced by mover(), and run().

core::pose::PoseOP protocols::jd3::standard::MoverAndPoseJob::pose_

private

Referenced by pose(), and run().

---

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

• src/protocols/jd3/standard/MoverAndPoseJob.hh
• src/protocols/jd3/standard/MoverAndPoseJob.cc