protocols::jd3::chunk_library::MoverAndChunkLibraryJob Class Reference

#include <MoverAndChunkLibraryJob.hh>

Inheritance diagram for protocols::jd3::chunk_library::MoverAndChunkLibraryJob:

Public Member Functions
	MoverAndChunkLibraryJob ()
	~MoverAndChunkLibraryJob () override
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 ChunkLibraryJobResultOP	create_job_result ()
	Factory method so derived classes can return their own result classes, which themselves should derive from ChunkLibraryJobResult. More...
virtual job_summaries::EnergyJobSummaryOP	create_job_summary ()
virtual void	finalize_job_result (ChunkLibraryJobResultOP 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 (job_summaries::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_
core::pose::PoseOP	lores_pose_ = nullptr

Constructor & Destructor Documentation

MoverAndChunkLibraryJob()

protocols::jd3::chunk_library::MoverAndChunkLibraryJob::MoverAndChunkLibraryJob

(

)

~MoverAndChunkLibraryJob()

protocols::jd3::chunk_library::MoverAndChunkLibraryJob::~MoverAndChunkLibraryJob ( )

overridedefault

Member Function Documentation

create_job_result()

ChunkLibraryJobResultOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::create_job_result ( )

protectedvirtual

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

Referenced by run().

create_job_summary()

EnergyJobSummaryOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::create_job_summary ( )

protectedvirtual

Referenced by run().

finalize_job_result()

void protocols::jd3::chunk_library::MoverAndChunkLibraryJob::finalize_job_result ( ChunkLibraryJobResultOP  result )

protectedvirtual

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

Referenced by run().

finalize_job_summary()

void protocols::jd3::chunk_library::MoverAndChunkLibraryJob::finalize_job_summary ( job_summaries::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.

Referenced by run().

mover() [1/2]

moves::MoverOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::mover

(

)

References mover_.

mover() [2/2]

void protocols::jd3::chunk_library::MoverAndChunkLibraryJob::mover

(

moves::MoverOP

setting

)

References mover_.

pose() [1/3]

core::pose::PoseOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::pose

(

)

References pose_.

pose() [2/3]

core::pose::PoseCOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::pose

(

)

const

References pose_.

pose() [3/3]

void protocols::jd3::chunk_library::MoverAndChunkLibraryJob::pose

(

core::pose::PoseOP

setting

)

References pose_.

run()

CompletedJobOutput protocols::jd3::chunk_library::MoverAndChunkLibraryJob::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, core::chemical::modifications::FAIL_BAD_INPUT, core::chemical::modifications::FAIL_DO_NOT_RETRY, core::chemical::modifications::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, protocols::jd3::CompletedJobOutput::job_results, lores_pose_, mover_, protocols::moves::MS_SUCCESS, pose_, and protocols::jd3::CompletedJobOutput::status.

Member Data Documentation

lores_pose_

core::pose::PoseOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::lores_pose_ = nullptr

private

Referenced by protocols::jd3::chunk_library::ChunkLibraryJobResult::lores_pose(), and run().

mover_

moves::MoverOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::mover_

private

Referenced by mover(), and run().

pose_

core::pose::PoseOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::pose_

private

Referenced by protocols::jd3::chunk_library::ChunkLibraryJobResult::pose(), pose(), and run().

---

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

• src/protocols/jd3/chunk_library/MoverAndChunkLibraryJob.hh
• src/protocols/jd3/chunk_library/MoverAndChunkLibraryJob.cc