Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::jd3::chunk_library::MoverAndChunkLibraryJob Class Reference

#include <MoverAndChunkLibraryJob.hh>

Inheritance diagram for protocols::jd3::chunk_library::MoverAndChunkLibraryJob:
Inheritance graph
[legend]

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

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

Member Function Documentation

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

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

Referenced by run().

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

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

void protocols::jd3::chunk_library::MoverAndChunkLibraryJob::mover ( moves::MoverOP  setting)

References mover_.

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

References mover_.

void protocols::jd3::chunk_library::MoverAndChunkLibraryJob::pose ( core::pose::PoseOP  setting)

References pose_.

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

References pose_.

core::pose::PoseCOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::pose ( ) const

References pose_.

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, 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, lores_pose_, mover_, protocols::moves::MS_SUCCESS, pose_, and protocols::jd3::CompletedJobOutput::status.

Member Data Documentation

core::pose::PoseOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::lores_pose_ = nullptr
private
moves::MoverOP protocols::jd3::chunk_library::MoverAndChunkLibraryJob::mover_
private

Referenced by mover(), and run().

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

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