|
SAGA C++ API 1.5.3
|
A checkpoint directory contains, you guess it, checkpoints. More...
#include <cpr_directory.hpp>

Public Member Functions | |
| directory (session const &s, saga::url url, int mode=saga::cpr::ReadWrite) | |
| Creates the object. | |
| directory (saga::url url, int mode=saga::cpr::ReadWrite) | |
| Creates the object. | |
| directory (saga::object const &o) | |
| Creates the object. | |
| directory (void) | |
| Creates the object. | |
| ~directory (void) | |
| Destroys the object. | |
| directory & | operator= (saga::object const &o) |
| Brief description starts here. | |
| bool | is_checkpoint (saga::url url) |
| Alias for is_entry of saga::ns_directory. | |
| saga::cpr::checkpoint | open (saga::url url, int flags=saga::cpr::Read) |
| Creates a new checkpoint instance. | |
| saga::cpr::directory | open_dir (saga::url url, int flags=saga::cpr::Read) |
| Creates a new directory instance. | |
| std::vector< saga::url > | find (std::string name_pattern, std::vector< std::string > const &meta_pattern=std::vector< std::string >(), int flags=saga::cpr::None, std::string spec="") |
| Find entries in the current directory and below, with matching names and matching meta data. | |
| std::vector () | |
| void | set_parent (saga::url checkpoint, saga::url parent, int generation=1) |
| set the previous checkpoint url | |
| saga::url | get_parent (saga::url checkpoint, int generation=1) |
| get the previous checkpoint url | |
| int | get_file_num (saga::url checkpoint) |
| get number of checkpoint files | |
| std::vector< saga::url > | list_files (saga::url checkpoint) |
| list the available checkpoint files | |
| int | add_file (saga::url checkpoint, saga::url url) |
| register a checkpoint file | |
| saga::url | get_file (saga::url checkpoint, int id) |
| get the url for a specific checkpoint file | |
| saga::filesystem::file | open_file (saga::url checkpoint, int id, int flags=CreateParents|Lock|ReadWrite) |
| open a specific checkpoint file by id | |
| saga::filesystem::file | open_file (saga::url checkpoint, saga::url url, int flags=CreateParents|Lock|ReadWrite) |
| open a specific checkpoint file by name | |
| void | remove_file (saga::url checkpoint, int id) |
| remove a specific checkpoint file by id | |
| void | remove_file (saga::url checkpoint, saga::url url) |
| remove a specific checkpoint file by name | |
| void | update_file (saga::url checkpoint, int id, saga::url new_url) |
| update a specific checkpoint file by id | |
| void | update_file (saga::url checkpoint, saga::url old_url, saga::url new_url) |
| update a specific checkpoint file by name | |
| void | stage_file (saga::url checkpoint, int id, saga::url new_url) |
| stage a specific checkpoint file by id | |
| void | stage_file (saga::url checkpoint, saga::url old_url, saga::url new_url) |
| stage a specific checkpoint file by name | |
| void | stage_file (saga::url checkpoint, saga::url new_url) |
| stage all checkpoint files | |
Static Public Member Functions | |
| static directory | create (session const &s, saga::url url, int mode=Read) |
| Factory function resembling directory(session, url, int) constructor. | |
| static directory | create (saga::url url, int mode=Read) |
| Factory function resembling directory(url, int) constructor. | |
| template<typename Tag > | |
| static saga::task | create (saga::url url, int mode=Read) |
| Factory function resembling entry(url, int) constructor. | |
Public Attributes | |
| int | |
| @ SAGA_CALL_CONST_PUB_2_DEF_1(find, std::string, | |
| CreateParents Lock | ReadWrite |
| @ SAGA_CALL_PUB_3_DEF_1 (open_file, saga::url, int, int, | |
Protected Types | |
| typedef saga::detail::attribute < directory > | attribute_base |
| typedef saga::name_space::directory::monitorable_base | monitorable_base |
Protected Member Functions | |
| TR1::shared_ptr < saga::impl::cpr_directory > | get_impl_sp () const |
| saga::impl::cpr_directory * | get_impl () const |
| directory (saga::impl::cpr_directory *impl) | |
A checkpoint directory contains, you guess it, checkpoints.
typedef saga::detail::attribute<directory> saga::cpr::directory::attribute_base [protected] |
typedef saga::name_space::directory::monitorable_base saga::cpr::directory::monitorable_base [protected] |
Reimplemented from saga::name_space::directory.
| saga::cpr::directory::directory | ( | saga::impl::cpr_directory * | impl | ) | [explicit, protected] |
| saga::cpr::directory::directory | ( | saga::object const & | o | ) | [explicit] |
Creates the object.
Reimplemented from saga::name_space::directory.
References saga::BadParameter, saga::object::CPRDirectory, and saga::object::get_type().
| saga::cpr::directory::directory | ( | void | ) |
Creates the object.
Reimplemented from saga::name_space::directory.
| saga::cpr::directory::~directory | ( | void | ) |
Destroys the object.
Reimplemented from saga::name_space::directory.
| TR1::shared_ptr< saga::impl::cpr_directory > saga::cpr::directory::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::directory.
| saga::impl::cpr_directory * saga::cpr::directory::get_impl | ( | void | ) | const [protected] |
Reimplemented from saga::name_space::directory.
Referenced by directory().
| static directory saga::cpr::directory::create | ( | session const & | s, |
| saga::url | url, | ||
| int | mode = Read |
||
| ) | [inline, static] |
Factory function resembling directory(session, url, int) constructor.
Reimplemented from saga::name_space::directory.
Factory function resembling directory(url, int) constructor.
Reimplemented from saga::name_space::directory.
| static saga::task saga::cpr::directory::create | ( | saga::url | url, |
| int | mode = Read |
||
| ) | [inline, static] |
Factory function resembling entry(url, int) constructor.
Reimplemented from saga::name_space::directory.
| directory & saga::cpr::directory::operator= | ( | saga::object const & | o | ) |
Brief description starts here.
Reimplemented from saga::name_space::directory.
| bool saga::cpr::directory::is_checkpoint | ( | saga::url | url | ) | [inline] |
Alias for is_entry of saga::ns_directory.
| saga::cpr::checkpoint saga::cpr::directory::open | ( | saga::url | url, |
| int | flags = saga::cpr::Read |
||
| ) | [inline] |
Creates a new checkpoint instance.
@ SAGA_CALL_PUB_1_DEF_0 (is_checkpoint, saga::url)
| url | File to be opened |
| flags | Flags definition operation modus |
Reimplemented from saga::name_space::directory.
| saga::cpr::directory saga::cpr::directory::open_dir | ( | saga::url | url, |
| int | flags = saga::cpr::Read |
||
| ) | [inline] |
Creates a new directory instance.
@ SAGA_CALL_PUB_2_DEF_1 (open, saga::url, int, saga::cpr::Read)
| url | Name of directory to open |
| flags | Flags definition operation modus |
Reimplemented from saga::name_space::directory.
| std::vector<saga::url> saga::cpr::directory::find | ( | std::string | name_pattern, |
| std::vector< std::string > const & | meta_pattern = std::vector <std::string>(), |
||
| int | flags = saga::cpr::None, |
||
| std::string | spec = "" |
||
| ) | [inline] |
Find entries in the current directory and below, with matching names and matching meta data.
@ SAGA_CALL_PUB_2_DEF_1 (open_dir, saga::url, int, saga::cpr::None)
| name_pattern | Pattern for names of entries to be found |
| meta_pattern | Pattern for meta data of entries to be found |
| flags | Flags defining the operation modus |
| saga::cpr::directory::std::vector | ( | ) |
| void saga::cpr::directory::set_parent | ( | saga::url | checkpoint, |
| saga::url | parent, | ||
| int | generation = 1 |
||
| ) | [inline] |
set the previous checkpoint url
| location | of checkpoint |
| generation | number of generations to go backwards |
get number of checkpoint files
@ SAGA_CALL_PUB_2_DEF_1 (get_parent, saga::url, int, 1)
| checkpoint | url |
list the available checkpoint files
@ SAGA_CALL_PUB_1_DEF_0 (get_file_num, saga::url)
| checkpoint | url |
register a checkpoint file
@ SAGA_CALL_PUB_1_DEF_0 (list_files, saga::url)
| checkpoint | url |
| file | url |
| saga::filesystem::file saga::cpr::directory::open_file | ( | saga::url | checkpoint, |
| int | id, | ||
| int | flags = CreateParents | Lock | ReadWrite |
||
| ) | [inline] |
open a specific checkpoint file by id
@ SAGA_CALL_PUB_2_DEF_0 (get_file, saga::url, int)
| checkpoint | url |
| file | id |
| open | flags |
| saga::filesystem::file saga::cpr::directory::open_file | ( | saga::url | checkpoint, |
| saga::url | url, | ||
| int | flags = CreateParents | Lock | ReadWrite |
||
| ) | [inline] |
open a specific checkpoint file by name
| checkpoint | url |
| file | url |
| open | flags |
remove a specific checkpoint file by id
| checkpoint | url |
| file | id |
remove a specific checkpoint file by name
@ SAGA_CALL_PUB_2_DEF_0 (remove_file, saga::url, int)
| checkpoint | url |
| file | url |
@ SAGA_CALL_CONST_PUB_2_DEF_1(find, std::string,
@ SAGA_CALL_PUB_4_DEF_1 (permissions_deny, std::string, std::string,
@ SAGA_CALL_PUB_4_DEF_1 (permissions_allow, std::string, std::string,
@ SAGA_CALL_PUB_4_DEF_1 (permissions_deny, saga::url, std::string,
@ SAGA_CALL_PUB_4_DEF_1 (permissions_allow, saga::url, std::string,
Reimplemented from saga::name_space::directory.
| CreateParents Lock saga::cpr::directory::ReadWrite |