SAGA C++ API 1.5.3

saga::cpr::job Class Reference

The job is a saga::job with additional checkpoint and recovery related methods. More...

#include <cpr_job.hpp>

Inheritance diagram for saga::cpr::job:

List of all members.

Public Member Functions

 job ()
 Creates the object.
 job (saga::object const &o)
 Creates the object.
 ~job ()
 Destroys the object.
joboperator= (saga::object const &o)
 Brief description starts here.
void checkpoint (saga::url u=saga::url())
 checkpoint a job
void recover (saga::url u=saga::url())
 recover a job
void cpr_stage_in (saga::url u=saga::url())
 stage-in a checkpoint file
void cpr_stage_out (saga::url u=saga::url())
 stage-out a checkpoint file
std::vector< saga::urlcpr_list (void)
 get list of known checkpoints
saga::url cpr_last (void)
 get last known checkpoint

Protected Types

typedef
saga::detail::attribute< job
attribute_base
 @ // job cpr management

Protected Member Functions

TR1::shared_ptr
< saga::impl::cpr_job > 
get_impl_sp (void) const
saga::impl::cpr_job * get_impl (void) const
 job (saga::impl::cpr_job *)

Detailed Description

The job is a saga::job with additional checkpoint and recovery related methods.


Member Typedef Documentation

@ // job cpr management

@ /** These methods are not within API scope */


Constructor & Destructor Documentation

job::job ( )

Creates the object.

job::job ( saga::object const &  o) [explicit]

Creates the object.

job::~job ( void  )

Destroys the object.


Member Function Documentation

TR1::shared_ptr< saga::impl::cpr_job > saga::cpr::job::get_impl_sp ( void  ) const [protected]
saga::impl::cpr_job * saga::cpr::job::get_impl ( void  ) const [protected]
job & saga::cpr::job::operator= ( saga::object const &  o)

Brief description starts here.

void saga::cpr::job::checkpoint ( saga::url  u = saga::url ()) [inline]

checkpoint a job

Returns:
void
void saga::cpr::job::recover ( saga::url  u = saga::url ()) [inline]

recover a job

@ SAGA_CALL_PUB_1_DEF_1 (checkpoint, saga::url, saga::url ())

Returns:
void
void saga::cpr::job::cpr_stage_in ( saga::url  u = saga::url ()) [inline]

stage-in a checkpoint file

@ SAGA_CALL_PUB_1_DEF_1 (recover, saga::url, saga::url ())

Returns:
void
void saga::cpr::job::cpr_stage_out ( saga::url  u = saga::url ()) [inline]

stage-out a checkpoint file

@ SAGA_CALL_PUB_1_DEF_1 (cpr_stage_in, saga::url, saga::url ())

Returns:
void
std::vector<saga::url> saga::cpr::job::cpr_list ( void  ) [inline]

get list of known checkpoints

@ SAGA_CALL_PUB_1_DEF_1 (cpr_stage_out, saga::url, saga::url ())

Returns:
list of known checkpoint URLs
saga::url saga::cpr::job::cpr_last ( void  ) [inline]

get last known checkpoint

@ SAGA_CALL_PUB_0_DEF_0 (cpr_list)

Returns:
last known checkpoint URL

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