SAGA C++ API 1.5.3

saga::cpr::checkpoint Class Reference

The saga::replica class implements the saga::attributes interface. More...

#include <cpr_checkpoint.hpp>

Inheritance diagram for saga::cpr::checkpoint:

List of all members.

Public Member Functions

 checkpoint (session const &s, saga::url url, int mode=Read)
 Creates the object.
 checkpoint (saga::url url, int mode=Read)
 Creates the object.
 checkpoint (saga::object const &o)
 Creates the object.
 checkpoint (void)
 Creates the object.
 ~checkpoint (void)
 Destroys the object.
checkpointoperator= (saga::object const &o)
 Brief description starts here.
void set_parent (saga::url url, int generation=1)
 set the previous checkpoint url
saga::url get_parent (int generation=1)
 get the previous checkpoint url
std::vector< saga::urllist_files (void)
 list the available checkpoint files
int add_file (saga::url url)
 register a checkpoint file
saga::url get_file (int id)
 get the url for a specific checkpoint file
saga::filesystem::file open_file (int id, int flags=CreateParents|Lock|ReadWrite)
 open a specific checkpoint file by id
saga::filesystem::file open_file (saga::url url, int flags=CreateParents|Lock|ReadWrite)
 open a specific checkpoint file by name
void remove_file (int id)
 remove a specific checkpoint file by id
void remove_file (saga::url url)
 remove a specific checkpoint file by name
void update_file (int id, saga::url new_url)
 update a specific checkpoint file by id
void update_file (saga::url old_url, saga::url new_url)
 update a specific checkpoint file by name
void stage_file (int id, saga::url new_url)
 stage a specific checkpoint file by id
void stage_file (saga::url old_url, saga::url new_url)
 stage a specific checkpoint file by name
void stage_file (saga::url new_url)
 stage all checkpoint files

Static Public Member Functions

static checkpoint create (session const &s, saga::url url, int mode=Read)
 Factory function resembling checkpoint(session, url, int) constructor.
static checkpoint create (saga::url url, int mode=Read)
 Factory function resembling checkpoint(url, int) constructor.
template<typename Tag >
static saga::task create (saga::url url, int mode=Read)
 Factory function resembling entry(url, int) constructor.

Protected Types

typedef
saga::detail::attribute
< checkpoint
attribute_base
typedef
saga::name_space::entry::monitorable_base 
monitorable_base

Protected Member Functions

TR1::shared_ptr
< saga::impl::cpr_checkpoint > 
get_impl_sp (void) const
saga::impl::cpr_checkpoint * get_impl (void) const
 checkpoint (saga::impl::cpr_checkpoint *impl)

Detailed Description

The saga::replica class implements the saga::attributes interface.

A checkpoint represents merely an entry in a name space which has (a) an associated set of registered (physical) checkpoint files of that checkpoint, and (b) an associated set of meta data describing that checkpoint. Both sets can be empty. To access the content of a checkpoint, a saga::file needs to be created with one of the registered file locations.


Member Typedef Documentation


Constructor & Destructor Documentation

saga::cpr::checkpoint::checkpoint ( saga::impl::cpr_checkpoint *  impl) [explicit, protected]
saga::cpr::checkpoint::checkpoint ( saga::object const &  o) [explicit]
saga::cpr::checkpoint::checkpoint ( void  )

Creates the object.

saga::cpr::checkpoint::~checkpoint ( void  )

Destroys the object.


Member Function Documentation

TR1::shared_ptr< saga::impl::cpr_checkpoint > saga::cpr::checkpoint::get_impl_sp ( void  ) const [protected]

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

Reimplemented from saga::name_space::entry.

saga::impl::cpr_checkpoint * saga::cpr::checkpoint::get_impl ( void  ) const [protected]

Reimplemented from saga::name_space::entry.

Referenced by checkpoint().

static checkpoint saga::cpr::checkpoint::create ( session const &  s,
saga::url  url,
int  mode = Read 
) [inline, static]

Factory function resembling checkpoint(session, url, int) constructor.

Reimplemented from saga::name_space::entry.

static checkpoint saga::cpr::checkpoint::create ( saga::url  url,
int  mode = Read 
) [inline, static]

Factory function resembling checkpoint(url, int) constructor.

Reimplemented from saga::name_space::entry.

template<typename Tag >
static saga::task saga::cpr::checkpoint::create ( saga::url  url,
int  mode = Read 
) [inline, static]

Factory function resembling entry(url, int) constructor.

Reimplemented from saga::name_space::entry.

checkpoint & saga::cpr::checkpoint::operator= ( saga::object const &  o)

Brief description starts here.

Reimplemented from saga::name_space::entry.

void saga::cpr::checkpoint::set_parent ( saga::url  url,
int  generation = 1 
) [inline]

set the previous checkpoint url

Parameters:
generationnumber of generations to go backwards
saga::url saga::cpr::checkpoint::get_parent ( int  generation = 1) [inline]

get the previous checkpoint url

@ SAGA_CALL_PUB_2_DEF_1 (set_parent, saga::url, int, 1)

Parameters:
generationnumber of generations to go backwards
std::vector<saga::url> saga::cpr::checkpoint::list_files ( void  ) [inline]

list the available checkpoint files

@ SAGA_CALL_PUB_1_DEF_1 (get_parent, int, 1)

int saga::cpr::checkpoint::add_file ( saga::url  url) [inline]

register a checkpoint file

@ SAGA_CALL_PUB_0_DEF_0 (list_files)

Parameters:
fileurl
saga::url saga::cpr::checkpoint::get_file ( int  id) [inline]

get the url for a specific checkpoint file

@ SAGA_CALL_PUB_1_DEF_0 (add_file, saga::url)

Parameters:
fileid
saga::filesystem::file saga::cpr::checkpoint::open_file ( int  id,
int  flags = CreateParents | Lock | ReadWrite 
) [inline]

open a specific checkpoint file by id

@ SAGA_CALL_PUB_1_DEF_0 (get_file, int)

Parameters:
fileid
openflags
saga::filesystem::file saga::cpr::checkpoint::open_file ( saga::url  url,
int  flags = CreateParents | Lock | ReadWrite 
) [inline]

open a specific checkpoint file by name

@ SAGA_CALL_PUB_2_DEF_1 (open_file, int, int, CreateParents | Lock | ReadWrite )

Parameters:
fileurl
openflags
void saga::cpr::checkpoint::remove_file ( int  id) [inline]

remove a specific checkpoint file by id

@ SAGA_CALL_PUB_2_DEF_1 (open_file, saga::url, int, CreateParents | Lock | ReadWrite)

Parameters:
checkpointurl
fileid
void saga::cpr::checkpoint::remove_file ( saga::url  url) [inline]

remove a specific checkpoint file by name

@ SAGA_CALL_PUB_1_DEF_0 (remove_file, int)

Parameters:
fileurl
void saga::cpr::checkpoint::update_file ( int  id,
saga::url  new_url 
) [inline]

update a specific checkpoint file by id

@ SAGA_CALL_PUB_1_DEF_0 (remove_file, saga::url)

Parameters:
fileid
newurl
void saga::cpr::checkpoint::update_file ( saga::url  old_url,
saga::url  new_url 
) [inline]

update a specific checkpoint file by name

@ SAGA_CALL_PUB_2_DEF_0 (update_file, int, saga::url)

Parameters:
oldurl
newurl
void saga::cpr::checkpoint::stage_file ( int  id,
saga::url  new_url 
) [inline]

stage a specific checkpoint file by id

@ SAGA_CALL_PUB_2_DEF_0 (update_file, saga::url, saga::url)

Parameters:
fileid
targeturl
void saga::cpr::checkpoint::stage_file ( saga::url  old_url,
saga::url  new_url 
) [inline]

stage a specific checkpoint file by name

@ SAGA_CALL_PUB_2_DEF_0 (stage_file, int, saga::url)

Parameters:
sourceurl
targeturl
void saga::cpr::checkpoint::stage_file ( saga::url  new_url) [inline]

stage all checkpoint files

@ SAGA_CALL_PUB_2_DEF_0 (stage_file, saga::url, saga::url)

Parameters:
targeturl

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