Package saga :: Package cpr :: Module _cpr :: Class directory

Class directory

          object --+                
                   |                
         ??.instance --+            
                       |            
          _engine.object --+        
                           |        
name_space._name_space.entry --+    
                               |    
name_space._name_space.directory --+
                                   |
                                  directory

Nested Classes

[hide private]

Inherited from _engine.object: object_type

Instance Methods

[hide private]

__init__(...)
__init__( (object)arg1, (url)arg2) -> None :

add_file(...)
add_file( (directory)arg1, (url)arg2, (url)arg3) -> int : register a checkpoint file (plain)

attribute_exists(...)
attribute_exists( (directory)arg1, (str)arg2) -> bool : tests if the given attribute exists for this instance (plain)

attribute_is_readonly(...)
attribute_is_readonly( (directory)arg1, (str)arg2) -> bool : tests if the given attribute is read only (plain)

attribute_is_removable(...)
attribute_is_removable( (directory)arg1, (str)arg2) -> bool : tests if the given attribute is removable (plain)

attribute_is_vector(...)
attribute_is_vector( (directory)arg1, (str)arg2) -> bool : tests if the given attribute is a vector attribute (plain)

attribute_is_writable(...)
attribute_is_writable( (directory)arg1, (str)arg2) -> bool : tests if the given attribute is writable (plain)

find(...)
find( (directory)arg1, (str)arg2, (object)arg3 [, (int)arg4 [, (str)arg5]]) -> object : finds cpr entries matching the given patterns (plain)

find_attributes(...)
find_attributes( (directory)arg1, (str)arg2) -> object : find attributes matching the given pattern (plain)

get_attribute(...)
get_attribute( (directory)arg1, (str)arg2) -> str : returns a (scalar) attribute associated with this object (plain)

get_file(...)
get_file( (directory)arg1, (url)arg2, (int)arg3) -> url : get the checkpoint file number n (plain)

get_file_num(...)
get_file_num( (directory)arg1, (url)arg2) -> int : get number of checkpoint files (plain)

get_parent(...)
get_parent( (directory)arg1, (url)arg2 [, (int)arg3]) -> url : get the previous checkpoint url (plain)

get_vector_attribute(...)
get_vector_attribute( (directory)arg1, (str)arg2) -> object : returns a (vector) attribute associated with this object (plain)

is_checkpoint(...)
is_checkpoint( (directory)arg1, (url)arg2) -> bool : returns, whether the given item refers to a checkpoint entry (plain)

list_attributes(...)
list_attributes( (directory)arg1) -> object : lists the keys of all attributes associated with this object (plain)

list_files(...)
list_files( (directory)arg1, (url)arg2) -> object : list the available checkpoint files (plain)

open(...)
open( (directory)arg1, (url)arg2 [, (int)arg3]) -> checkpoint : opens the given file in this directory (plain)

open_dir(...)
open_dir( (directory)arg1, (url)arg2 [, (int)arg3]) -> directory : opens the given directory in this directory (plain)

open_file(...)
open_file( (directory)arg1, (url)arg2, (int)arg3 [, (int)arg4]) -> file : open checkpoint file number n (plain)

remove_attribute(...)
remove_attribute( (directory)arg1, (str)arg2) -> None : removes an attribute associated with this object (plain)

remove_file(...)
remove_file( (directory)arg1, (url)arg2, (int)arg3) -> None : remove a specific checkpoint file by id (plain)

set_attribute(...)
set_attribute( (directory)arg1, (str)arg2, (str)arg3) -> None : sets a (scalar) attribute associated with this object (plain)

set_parent(...)
set_parent( (directory)arg1, (url)arg2, (url)arg3 [, (int)arg4]) -> None : set the previous checkpoint url (plain)

set_vector_attribute(...)
set_vector_attribute( (directory)arg1, (str)arg2, (object)arg3) -> None : sets a (vector) attribute associated with this object (plain)

stage_file(...)
stage_file( (directory)arg1, (url)arg2, (int)arg3, (url)arg4) -> None : stage a specific checkpoint file by id (plain)

update_file(...)
update_file( (directory)arg1, (url)arg2, (int)arg3, (url)arg4) -> None : update a specific checkpoint file by id (plain)

Inherited from name_space._name_space.directory: change_dir, copy, exists, get_entry, get_num_entries, is_dir, is_entry, is_link, link, list, make_dir, move, permissions_allow, permissions_deny, read_link, remove

Inherited from name_space._name_space.entry: close, get_cwd, get_group, get_name, get_owner, get_url, permissions_check

Inherited from _engine.object: __reduce__, clone, get_id, get_object_type_name, get_session, get_type

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

Inherited from _engine.object: Advert, AdvertDirectory, Buffer, Context, Directory, Endpoint, Exception, File, IOVec, Job, JobDescription, JobSelf, JobService, LogicalDirectory, LogicalFile, Metric, Msg, NSDirectory, NSEntry, Parameter, RPC, Session, Stream, StreamService, Task, TaskContainer, URL, __instance_size__

Properties

[hide private]

Inherited from _engine.object: id, session, type

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)


__init__( (object)arg1, (url)arg2) -> None :

    C++ signature :
        void __init__(_object*,saga::url)

__init__( (object)arg1, (url)arg2, (int)arg3) -> None :

    C++ signature :
        void __init__(_object*,saga::url,int)

__init__( (object)arg1, (session)arg2, (url)arg3) -> None :

    C++ signature :
        void __init__(_object*,saga::session,saga::url)

__init__( (object)arg1, (session)arg2, (url)arg3, (int)arg4) -> None :

    C++ signature :
        void __init__(_object*,saga::session,saga::url,int)

Overrides: object.__init__

add_file(...)


add_file( (directory)arg1, (url)arg2, (url)arg3) -> int :
    register a checkpoint file (plain)

    C++ signature :
        int add_file(saga::cpr::directory,saga::url,saga::url)

add_file( (directory)arg1, (routine_type)arg2, (url)arg3, (url)arg4) -> task :
    register a checkpoint file (task based)

    C++ signature :
        saga::task add_file(saga::cpr::directory,saga::python::routine_type,saga::url,saga::url)

attribute_exists(...)


attribute_exists( (directory)arg1, (str)arg2) -> bool :
    tests if the given attribute exists for this instance (plain)

    C++ signature :
        bool attribute_exists(saga::cpr::directory,std::string)

attribute_exists( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute exists for this instance (task based)

    C++ signature :
        saga::task attribute_exists(saga::cpr::directory,saga::python::routine_type,std::string)

attribute_is_readonly(...)


attribute_is_readonly( (directory)arg1, (str)arg2) -> bool :
    tests if the given attribute is read only (plain)

    C++ signature :
        bool attribute_is_readonly(saga::cpr::directory,std::string)

attribute_is_readonly( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is read only (task based)

    C++ signature :
        saga::task attribute_is_readonly(saga::cpr::directory,saga::python::routine_type,std::string)

attribute_is_removable(...)


attribute_is_removable( (directory)arg1, (str)arg2) -> bool :
    tests if the given attribute is removable (plain)

    C++ signature :
        bool attribute_is_removable(saga::cpr::directory,std::string)

attribute_is_removable( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is removable (task based)

    C++ signature :
        saga::task attribute_is_removable(saga::cpr::directory,saga::python::routine_type,std::string)

attribute_is_vector(...)


attribute_is_vector( (directory)arg1, (str)arg2) -> bool :
    tests if the given attribute is a vector attribute (plain)

    C++ signature :
        bool attribute_is_vector(saga::cpr::directory,std::string)

attribute_is_vector( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is a vector attribute (task based)

    C++ signature :
        saga::task attribute_is_vector(saga::cpr::directory,saga::python::routine_type,std::string)

attribute_is_writable(...)


attribute_is_writable( (directory)arg1, (str)arg2) -> bool :
    tests if the given attribute is writable (plain)

    C++ signature :
        bool attribute_is_writable(saga::cpr::directory,std::string)

attribute_is_writable( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is writable (task based)

    C++ signature :
        saga::task attribute_is_writable(saga::cpr::directory,saga::python::routine_type,std::string)

find(...)


find( (directory)arg1, (str)arg2, (object)arg3 [, (int)arg4 [, (str)arg5]]) -> object :
    finds cpr entries matching the given patterns (plain)

    C++ signature :
        std::vector<saga::url, std::allocator<saga::url> > find(saga::cpr::directory,std::string,std::vector<std::string, std::allocator<std::string> > [,int [,std::string]])

find( (directory)arg1, (routine_type)arg2, (str)arg3, (object)arg4 [, (int)arg5 [, (str)arg6]]) -> task :
    finds cpr entries matching the given patterns (task based)

    C++ signature :
        saga::task find(saga::cpr::directory,saga::python::routine_type,std::string,std::vector<std::string, std::allocator<std::string> > [,int [,std::string]])

Overrides: name_space._name_space.directory.find

find_attributes(...)


find_attributes( (directory)arg1, (str)arg2) -> object :
    find attributes matching the given pattern (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > find_attributes(saga::cpr::directory,std::string)

find_attributes( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    find attributes matching the given pattern (task based)

    C++ signature :
        saga::task find_attributes(saga::cpr::directory,saga::python::routine_type,std::string)

get_attribute(...)


get_attribute( (directory)arg1, (str)arg2) -> str :
    returns a (scalar) attribute associated with this object (plain)

    C++ signature :
        std::string get_attribute(saga::cpr::directory,std::string)

get_attribute( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    returns a (scalar) attribute associated with this object (task based)

    C++ signature :
        saga::task get_attribute(saga::cpr::directory,saga::python::routine_type,std::string)

get_file(...)


get_file( (directory)arg1, (url)arg2, (int)arg3) -> url :
    get the checkpoint file number n (plain)

    C++ signature :
        saga::url get_file(saga::cpr::directory,saga::url,int)

get_file( (directory)arg1, (routine_type)arg2, (url)arg3, (int)arg4) -> task :
    get the checkpoint file number n (task based)

    C++ signature :
        saga::task get_file(saga::cpr::directory,saga::python::routine_type,saga::url,int)

get_file_num(...)


get_file_num( (directory)arg1, (url)arg2) -> int :
    get number of checkpoint files (plain)

    C++ signature :
        int get_file_num(saga::cpr::directory,saga::url)

get_file_num( (directory)arg1, (routine_type)arg2, (url)arg3) -> task :
    get number of checkpoint files (task based)

    C++ signature :
        saga::task get_file_num(saga::cpr::directory,saga::python::routine_type,saga::url)

get_parent(...)


get_parent( (directory)arg1, (url)arg2 [, (int)arg3]) -> url :
    get the previous checkpoint url (plain)

    C++ signature :
        saga::url get_parent(saga::cpr::directory,saga::url [,int])

get_parent( (directory)arg1, (routine_type)arg2, (url)arg3 [, (int)arg4]) -> task :
    get the previous checkpoint url (task based)

    C++ signature :
        saga::task get_parent(saga::cpr::directory,saga::python::routine_type,saga::url [,int])

get_vector_attribute(...)


get_vector_attribute( (directory)arg1, (str)arg2) -> object :
    returns a (vector) attribute associated with this object (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > get_vector_attribute(saga::cpr::directory,std::string)

get_vector_attribute( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    returns a (vector) attribute associated with this object (task based)

    C++ signature :
        saga::task get_vector_attribute(saga::cpr::directory,saga::python::routine_type,std::string)

is_checkpoint(...)


is_checkpoint( (directory)arg1, (url)arg2) -> bool :
    returns, whether the given item refers to a checkpoint entry (plain)

    C++ signature :
        bool is_checkpoint(saga::cpr::directory,saga::url)

is_checkpoint( (directory)arg1, (routine_type)arg2, (url)arg3) -> task :
    returns, whether the given item refers to a checkpoint entry (task based)

    C++ signature :
        saga::task is_checkpoint(saga::cpr::directory,saga::python::routine_type,saga::url)

list_attributes(...)


list_attributes( (directory)arg1) -> object :
    lists the keys of all attributes associated with this object (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > list_attributes(saga::cpr::directory)

list_attributes( (directory)arg1, (routine_type)arg2) -> task :
    lists the keys of all attributes associated with this object (task based)

    C++ signature :
        saga::task list_attributes(saga::cpr::directory,saga::python::routine_type)

list_files(...)


list_files( (directory)arg1, (url)arg2) -> object :
    list the available checkpoint files (plain)

    C++ signature :
        std::vector<saga::url, std::allocator<saga::url> > list_files(saga::cpr::directory,saga::url)

list_files( (directory)arg1, (routine_type)arg2, (url)arg3) -> task :
    list the available checkpoint files (task based)

    C++ signature :
        saga::task list_files(saga::cpr::directory,saga::python::routine_type,saga::url)

open(...)


open( (directory)arg1, (url)arg2 [, (int)arg3]) -> checkpoint :
    opens the given file in this directory (plain)

    C++ signature :
        saga::cpr::checkpoint open(saga::cpr::directory,saga::url [,int])

open( (directory)arg1, (routine_type)arg2, (url)arg3 [, (int)arg4]) -> task :
    opens the given file in this directory (task based)

    C++ signature :
        saga::task open(saga::cpr::directory,saga::python::routine_type,saga::url [,int])

Overrides: name_space._name_space.directory.open

open_dir(...)


open_dir( (directory)arg1, (url)arg2 [, (int)arg3]) -> directory :
    opens the given directory in this directory (plain)

    C++ signature :
        saga::cpr::directory open_dir(saga::cpr::directory,saga::url [,int])

open_dir( (directory)arg1, (routine_type)arg2, (url)arg3 [, (int)arg4]) -> task :
    opens the given directory in this directory (task based)

    C++ signature :
        saga::task open_dir(saga::cpr::directory,saga::python::routine_type,saga::url [,int])

Overrides: name_space._name_space.directory.open_dir

open_file(...)


open_file( (directory)arg1, (url)arg2, (int)arg3 [, (int)arg4]) -> file :
    open checkpoint file number n (plain)

    C++ signature :
        saga::filesystem::file open_file(saga::cpr::directory,saga::url,int [,int])

open_file( (directory)arg1, (routine_type)arg2, (url)arg3, (int)arg4 [, (int)arg5]) -> task :
    open checkpoint file number n (task based)

    C++ signature :
        saga::task open_file(saga::cpr::directory,saga::python::routine_type,saga::url,int [,int])

open_file( (directory)arg1, (url)arg2, (url)arg3 [, (int)arg4]) -> file :
    open checkpoint file by name (plain)

    C++ signature :
        saga::filesystem::file open_file(saga::cpr::directory,saga::url,saga::url [,int])

open_file( (directory)arg1, (routine_type)arg2, (url)arg3, (url)arg4 [, (int)arg5]) -> task :
    open checkpoint file by name (task based)

    C++ signature :
        saga::task open_file(saga::cpr::directory,saga::python::routine_type,saga::url,saga::url [,int])

remove_attribute(...)


remove_attribute( (directory)arg1, (str)arg2) -> None :
    removes an attribute associated with this object (plain)

    C++ signature :
        void remove_attribute(saga::cpr::directory,std::string)

remove_attribute( (directory)arg1, (routine_type)arg2, (str)arg3) -> task :
    removes an attribute associated with this object (task based)

    C++ signature :
        saga::task remove_attribute(saga::cpr::directory,saga::python::routine_type,std::string)

remove_file(...)


remove_file( (directory)arg1, (url)arg2, (int)arg3) -> None :
    remove a specific checkpoint file by id (plain)

    C++ signature :
        void remove_file(saga::cpr::directory,saga::url,int)

remove_file( (directory)arg1, (routine_type)arg2, (url)arg3, (int)arg4) -> task :
    remove a specific checkpoint file by id (task based)

    C++ signature :
        saga::task remove_file(saga::cpr::directory,saga::python::routine_type,saga::url,int)

remove_file( (directory)arg1, (url)arg2, (url)arg3) -> None :
    remove a specific checkpoint file by name (plain)

    C++ signature :
        void remove_file(saga::cpr::directory,saga::url,saga::url)

remove_file( (directory)arg1, (routine_type)arg2, (url)arg3, (url)arg4) -> task :
    remove a specific checkpoint file by name (task based)

    C++ signature :
        saga::task remove_file(saga::cpr::directory,saga::python::routine_type,saga::url,saga::url)

set_attribute(...)


set_attribute( (directory)arg1, (str)arg2, (str)arg3) -> None :
    sets a (scalar) attribute associated with this object (plain)

    C++ signature :
        void set_attribute(saga::cpr::directory,std::string,std::string)

set_attribute( (directory)arg1, (routine_type)arg2, (str)arg3, (str)arg4) -> task :
    sets a (scalar) attribute associated with this object (task based)

    C++ signature :
        saga::task set_attribute(saga::cpr::directory,saga::python::routine_type,std::string,std::string)

set_parent(...)


set_parent( (directory)arg1, (url)arg2, (url)arg3 [, (int)arg4]) -> None :
    set the previous checkpoint url (plain)

    C++ signature :
        void set_parent(saga::cpr::directory,saga::url,saga::url [,int])

set_parent( (directory)arg1, (routine_type)arg2, (url)arg3, (url)arg4 [, (int)arg5]) -> task :
    set the previous checkpoint url (task based)

    C++ signature :
        saga::task set_parent(saga::cpr::directory,saga::python::routine_type,saga::url,saga::url [,int])

set_vector_attribute(...)


set_vector_attribute( (directory)arg1, (str)arg2, (object)arg3) -> None :
    sets a (vector) attribute associated with this object (plain)

    C++ signature :
        void set_vector_attribute(saga::cpr::directory,std::string,std::vector<std::string, std::allocator<std::string> >)

set_vector_attribute( (directory)arg1, (routine_type)arg2, (str)arg3, (object)arg4) -> task :
    sets a (vector) attribute associated with this object (task based)

    C++ signature :
        saga::task set_vector_attribute(saga::cpr::directory,saga::python::routine_type,std::string,std::vector<std::string, std::allocator<std::string> >)

stage_file(...)


stage_file( (directory)arg1, (url)arg2, (int)arg3, (url)arg4) -> None :
    stage a specific checkpoint file by id (plain)

    C++ signature :
        void stage_file(saga::cpr::directory,saga::url,int,saga::url)

stage_file( (directory)arg1, (routine_type)arg2, (url)arg3, (int)arg4, (url)arg5) -> task :
    stage a specific checkpoint file by id (task based)

    C++ signature :
        saga::task stage_file(saga::cpr::directory,saga::python::routine_type,saga::url,int,saga::url)

stage_file( (directory)arg1, (url)arg2, (url)arg3, (url)arg4) -> None :
    stage a specific checkpoint file by name (plain)

    C++ signature :
        void stage_file(saga::cpr::directory,saga::url,saga::url,saga::url)

stage_file( (directory)arg1, (routine_type)arg2, (url)arg3, (url)arg4, (url)arg5) -> task :
    stage a specific checkpoint file by name (task based)

    C++ signature :
        saga::task stage_file(saga::cpr::directory,saga::python::routine_type,saga::url,saga::url,saga::url)

update_file(...)


update_file( (directory)arg1, (url)arg2, (int)arg3, (url)arg4) -> None :
    update a specific checkpoint file by id (plain)

    C++ signature :
        void update_file(saga::cpr::directory,saga::url,int,saga::url)

update_file( (directory)arg1, (routine_type)arg2, (url)arg3, (int)arg4, (url)arg5) -> task :
    update a specific checkpoint file by id (task based)

    C++ signature :
        saga::task update_file(saga::cpr::directory,saga::python::routine_type,saga::url,int,saga::url)

update_file( (directory)arg1, (url)arg2, (url)arg3, (url)arg4) -> None :
    update a specific checkpoint file by name (plain)

    C++ signature :
        void update_file(saga::cpr::directory,saga::url,saga::url,saga::url)

update_file( (directory)arg1, (routine_type)arg2, (url)arg3, (url)arg4, (url)arg5) -> task :
    update a specific checkpoint file by name (task based)

    C++ signature :
        saga::task update_file(saga::cpr::directory,saga::python::routine_type,saga::url,saga::url,saga::url)

Class directory

__init__(...) (Constructor)

add_file(...)

attribute_exists(...)

attribute_is_readonly(...)

attribute_is_removable(...)

attribute_is_vector(...)

attribute_is_writable(...)

find(...)

find_attributes(...)

get_attribute(...)

get_file(...)

get_file_num(...)

get_parent(...)

get_vector_attribute(...)

is_checkpoint(...)

list_attributes(...)

list_files(...)

open(...)

open_dir(...)

open_file(...)

remove_attribute(...)

remove_file(...)

set_attribute(...)

set_parent(...)

set_vector_attribute(...)

stage_file(...)

update_file(...)

init(...)
(Constructor)