Rosetta 3.4
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
protocols::jd2::BOINCJobDistributor Class Reference

#include <BOINCJobDistributor.hh>

Inheritance diagram for protocols::jd2::BOINCJobDistributor:
Inheritance graph
[legend]
Collaboration diagram for protocols::jd2::BOINCJobDistributor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~BOINCJobDistributor ()
 dtor WARNING WARNING! SINGLETONS' DESTRUCTORS ARE NEVER CALLED IN MINI! DO NOT TRY TO PUT THINGS IN THIS FUNCTION! here's a nice link explaining why: http://www.research.ibm.com/designpatterns/pubs/ph-jun96.txt
void checkpoint_read ()
void checkpoint_write ()
void checkpoint_clear ()
virtual void go (protocols::moves::MoverOP mover)
 This may be overridden by derived classes. Default implementation invokes go_main.
virtual core::Size get_new_job_id ()
 dummy for master/slave version

Protected Member Functions

 BOINCJobDistributor ()
 ctor is protected; singleton pattern
virtual void job_failed (core::pose::Pose &pose, bool will_retry)
 This function is called when we five up on the job; it has been virtualized so BOINC and MPI can delay/protect output base implementation is just a call to the job outputter.
virtual void job_succeeded (core::pose::Pose &pose, core::Real run_time)
 This function is called upon a successful job completion; it has been virtualized so BOINC and MPI can delay/protect output base implementation is just a call to the job outputter.
virtual void mark_current_job_id_for_repetition ()
 this function is called whenever a job "soft-fails" and needs to be retried. Generally it should ensure that the subsequent call to obtain_new_job returns this job over again.
virtual void begin_critical_section ()
virtual void end_critical_section ()

Protected Attributes

core::Size total_completed_nstruct_

Friends

class JobDistributorFactory

Constructor & Destructor Documentation

protocols::jd2::BOINCJobDistributor::BOINCJobDistributor ( ) [protected]

ctor is protected; singleton pattern

constructor. Notice it calls the parent class!

References checkpoint_read(), and protocols::boinc::Boinc::worker_startup().

protocols::jd2::BOINCJobDistributor::~BOINCJobDistributor ( ) [virtual]

dtor WARNING WARNING! SINGLETONS' DESTRUCTORS ARE NEVER CALLED IN MINI! DO NOT TRY TO PUT THINGS IN THIS FUNCTION! here's a nice link explaining why: http://www.research.ibm.com/designpatterns/pubs/ph-jun96.txt


Member Function Documentation

void protocols::jd2::BOINCJobDistributor::begin_critical_section ( ) [protected, virtual]

Reimplemented from protocols::jd2::JobDistributor.

Referenced by checkpoint_read(), and checkpoint_write().

void protocols::jd2::BOINCJobDistributor::checkpoint_clear ( )

References protocols::swa::rna::file_exists().

Referenced by go().

void protocols::jd2::BOINCJobDistributor::checkpoint_read ( )
void protocols::jd2::BOINCJobDistributor::checkpoint_write ( )
void protocols::jd2::BOINCJobDistributor::end_critical_section ( ) [protected, virtual]

Reimplemented from protocols::jd2::JobDistributor.

Referenced by checkpoint_read(), and checkpoint_write().

core::Size protocols::jd2::BOINCJobDistributor::get_new_job_id ( ) [virtual]
void protocols::jd2::BOINCJobDistributor::go ( protocols::moves::MoverOP  mover) [virtual]
void protocols::jd2::BOINCJobDistributor::job_failed ( core::pose::Pose pose,
bool  will_retry 
) [protected, virtual]

This function is called when we five up on the job; it has been virtualized so BOINC and MPI can delay/protect output base implementation is just a call to the job outputter.

Reimplemented from protocols::jd2::FileSystemJobDistributor.

References protocols::jd2::JobDistributor::current_job(), and job_succeeded().

void protocols::jd2::BOINCJobDistributor::job_succeeded ( core::pose::Pose pose,
core::Real  run_time 
) [protected, virtual]

This function is called upon a successful job completion; it has been virtualized so BOINC and MPI can delay/protect output base implementation is just a call to the job outputter.

Reimplemented from protocols::jd2::FileSystemJobDistributor.

References checkpoint_write(), and total_completed_nstruct_.

Referenced by job_failed().

void protocols::jd2::BOINCJobDistributor::mark_current_job_id_for_repetition ( ) [protected, virtual]

this function is called whenever a job "soft-fails" and needs to be retried. Generally it should ensure that the subsequent call to obtain_new_job returns this job over again.

Reimplemented from protocols::jd2::ShuffleFileSystemJobDistributor.


Friends And Related Function Documentation

friend class JobDistributorFactory [friend]

Member Data Documentation

Referenced by get_new_job_id(), go(), and job_succeeded().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines