Package saga :: Package filesystem :: Module _filesystem :: Class file

Class file

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

Known Subclasses:

file

Inherited from _engine.object
Nested Classes
	seek_mode
	object_type

Instance Methods

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

get_size(...)
get_size( (file)arg1) -> long : returns the size of this file (plain)

read(...)
read( (file)arg1, (object)arg2 [, (int)arg3]) -> int : reads the given number of bytes from the file (plain)

seek(...)
seek( (file)arg1, (long)arg2, (seek_mode)arg3) -> long : repositions the current file pointer (plain)

write(...)
write( (file)arg1, (object)arg2 [, (int)arg3]) -> int : writes the given bytes to the file (plain)

Inherited from unreachable.instance: __new__

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

Inherited from name_space._name_space.entry

close(...)
close( (entry)arg1) -> None : closes this entry (plain)

copy(...)
copy( (entry)arg1, (url)arg2 [, (int)arg3]) -> None : copies this item to the given name (url) (plain)

get_cwd(...)
get_cwd( (entry)arg1) -> url : returns the directory name this item is located in (plain)

get_group(...)
get_group( (entry)arg1) -> str : returns the group of the owner of this object instance (plain)

get_name(...)
get_name( (entry)arg1) -> url : returns the name of this item (plain)

get_owner(...)
get_owner( (entry)arg1) -> str : returns the owner of this object instance (plain)

get_url(...)
get_url( (entry)arg1) -> url : returns the full url of this item (plain)

is_dir(...)
is_dir( (entry)arg1) -> bool : returns, whether this item refers to a directory (plain)

is_entry(...)
is_entry( (entry)arg1) -> bool : returns, whether this item refers to a simple entry (plain)

is_link(...)
is_link( (entry)arg1) -> bool : returns, whether this item is a link to another entry (plain)

link(...)
link( (entry)arg1, (url)arg2 [, (int)arg3]) -> None : links this item to the given item (url) (plain)

move(...)
move( (entry)arg1, (url)arg2 [, (int)arg3]) -> None : moves this item to the given name (url) (plain)

permissions_allow(...)
permissions_allow( (entry)arg1, (str)arg2, (int)arg3) -> None : generically enable a permission on this namespace entry (plain)

permissions_check(...)
permissions_check( (entry)arg1, (str)arg2, (int)arg3) -> bool : generically check a permission on this namespace entry (plain)

permissions_deny(...)
permissions_deny( (entry)arg1, (str)arg2, (int)arg3) -> None : generically disable a permission on this namespace entry (plain)

read_link(...)
read_link( (entry)arg1) -> url : returns the name of the item this entry is linked to (plain)

remove(...)
remove( (entry)arg1) -> None : removes this entry (plain)

Inherited from _engine.object

__reduce__(...)
helper for pickle

clone(...)
clone( (object)arg1) -> object : create a deep copy of the object

get_id(...)
get_id( (object)arg1) -> uuid : returns the id of this instance

get_object_type_name(...)
get_object_type_name( (object_type)arg1) -> str : return the name of a given object type

get_session(...)
get_session( (object)arg1) -> session : return the session associated with this object instance

get_type(...)
get_type( (object)arg1) -> object_type : returns the type of this instance

Inherited from _engine.object
Class Variables
	Current = `saga.filesystem._filesystem.seek_mode.Current`
	End = `saga.filesystem._filesystem.seek_mode.End`
	Start = `saga.filesystem._filesystem.seek_mode.Start`
	Advert = `saga._engine.object_type.Advert`
	AdvertDirectory = `saga._engine.object_type.AdvertDirectory`
	Buffer = `saga._engine.object_type.Buffer`
	CPRCheckpoint = `saga._engine.object_type.CPRCheckpoint`
	CPRDirectory = `saga._engine.object_type.CPRDirectory`
	CPRJob = `saga._engine.object_type.CPRJob`
	CPRJobDescription = `saga._engine.object_type.CPRJobDescription`
	CPRJobSelf = `saga._engine.object_type.CPRJobSelf`
	CPRJobService = `saga._engine.object_type.CPRJobService`
	Context = `saga._engine.object_type.Context`
	Directory = `saga._engine.object_type.Directory`
	Endpoint = `saga._engine.object_type.Endpoint`
	EntityData = `saga._engine.object_type.EntityData`
	EntityDataSet = `saga._engine.object_type.EntityDataSet`
	EntityNavigator = `saga._engine.object_type.EntityNavigator`
	Exception = `saga._engine.object_type.Exception`
	File = `saga._engine.object_type.File`
	IOVec = `saga._engine.object_type.IOVec`
	Job = `saga._engine.object_type.Job`
	JobDescription = `saga._engine.object_type.JobDescription`
	JobSelf = `saga._engine.object_type.JobSelf`
	JobService = `saga._engine.object_type.JobService`
	LogicalDirectory = `saga._engine.object_type.LogicalDirectory`
	LogicalFile = `saga._engine.object_type.LogicalFile`
	Metric = `saga._engine.object_type.Metric`
	Msg = `saga._engine.object_type.Msg`
	NSDirectory = `saga._engine.object_type.NSDirectory`
	NSEntry = `saga._engine.object_type.NSEntry`
	Parameter = `saga._engine.object_type.Parameter`
	RPC = `saga._engine.object_type.RPC`
	ServiceData = `saga._engine.object_type.ServiceData`
	ServiceDescription = `saga._engine.object_type.ServiceDescription`
	ServiceDiscoverer = `saga._engine.object_type.ServiceDiscoverer`
	Session = `saga._engine.object_type.Session`
	Stream = `saga._engine.object_type.Stream`
	StreamServer = `saga._engine.object_type.StreamServer`
	Task = `saga._engine.object_type.Task`
	TaskContainer = `saga._engine.object_type.TaskContainer`
	URL = `saga._engine.object_type.URL`
	__instance_size__ = `32`

Inherited from _engine.object
Properties
Inherited from `object`: `__class__`
	id returns the id of this instance
	session return the session associated with this object instance
	type returns the type of this instance

Method Details

init(...)
(Constructor)


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

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

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

    C++ signature :
        void __init__(_object*,std::string)

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

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

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

    C++ signature :
        void __init__(_object*,std::string,int)

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

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

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

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

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

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

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

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

Overrides: object.__init__

get_size(...)


get_size( (file)arg1) -> long :
    returns the size of this file (plain)

    C++ signature :
        long long get_size(saga::filesystem::file)

get_size( (file)arg1, (routine_type)arg2) -> task :
    returns the size of this file (task based)

    C++ signature :
        saga::task get_size(saga::filesystem::file,saga::python::routine_type)

read(...)


read( (file)arg1, (object)arg2 [, (int)arg3]) -> int :
    reads the given number of bytes from the file (plain)

    C++ signature :
        long read(saga::filesystem::file,saga::mutable_buffer [,unsigned long])

read( (file)arg1, (routine_type)arg2, (object)arg3 [, (int)arg4]) -> task :
    reads the given number of bytes from the file (task based)

    C++ signature :
        saga::task read(saga::filesystem::file,saga::python::routine_type,saga::mutable_buffer [,unsigned long])

read( (file)arg1 [, (int)arg2]) -> object :
    reads the given number of bytes from the file (plain)

    C++ signature :
        boost::python::handle<_object> read(saga::filesystem::file [,unsigned long])

read( (file)arg1, (routine_type)arg2 [, (int)arg3]) -> task :
    reads the given number of bytes from the file (task based)

    C++ signature :
        saga::task read(saga::filesystem::file,saga::python::routine_type [,unsigned long])

seek(...)


seek( (file)arg1, (long)arg2, (seek_mode)arg3) -> long :
    repositions the current file pointer (plain)

    C++ signature :
        long long seek(saga::filesystem::file,long long,saga::filesystem::seek_mode)

seek( (file)arg1, (routine_type)arg2, (long)arg3, (seek_mode)arg4) -> task :
    repositions the current file pointer (task based)

    C++ signature :
        saga::task seek(saga::filesystem::file,saga::python::routine_type,long long,saga::filesystem::seek_mode)

write(...)


write( (file)arg1, (object)arg2 [, (int)arg3]) -> int :
    writes the given bytes to the file (plain)

    C++ signature :
        long write(saga::filesystem::file,saga::mutable_buffer [,unsigned long])

write( (file)arg1, (routine_type)arg2, (object)arg3 [, (int)arg4]) -> task :
    writes the given bytes to the file (task based)

    C++ signature :
        saga::task write(saga::filesystem::file,saga::python::routine_type,saga::mutable_buffer [,unsigned long])

write( (file)arg1, (object)arg2) -> int :
    writes the given bytes to the file (plain)

    C++ signature :
        long write(saga::filesystem::file,boost::python::api::object)

write( (file)arg1, (routine_type)arg2, (object)arg3) -> task :
    writes the given bytes to the file (task based)

    C++ signature :
        saga::task write(saga::filesystem::file,saga::python::routine_type,boost::python::api::object)