hdf5fs.h5fs.H5fs Class Reference

List of all members.

Public Member Functions

def normpath
def mkparents
def path2hdf
def hdf2path
def hdf2abspath
def refdir
def refdir2
def chdir
def exists
def makedirs
def mkdir
def link
def symlink
def rename
def mount
def open
def unlink
def rmdir
def umount
def stat
def __init__

Public Attributes

 cwdref
 cwd
 type
 rootref
 dirsep
 slashrep
 autodir
 autocd

Detailed Description

Definition at line 33 of file h5fs.py.


Member Function Documentation

def hdf5fs.h5fs.H5fs.normpath (   self,
  path 
)

normpath(path) -->  normalized path

normalize given path

@rtype:   string
@return:  normalized path

normpath from os.path is not useful here: '..' is not
treated specially in HDF5

Definition at line 38 of file h5fs.py.

def hdf5fs.h5fs.H5fs.mkparents (   self,
  dir,
  path 
)

Definition at line 60 of file h5fs.py.

def hdf5fs.h5fs.H5fs.path2hdf (   self,
  path 
)

translate path to hdf5-compatible format
@rtype:  string
@return: hdf5-compatible path

Definition at line 64 of file h5fs.py.

def hdf5fs.h5fs.H5fs.hdf2path (   self,
  path 
)

translate path from hdf5 to external format
@rtype:  string
@return: path in external format

Definition at line 77 of file h5fs.py.

def hdf5fs.h5fs.H5fs.hdf2abspath (   self,
  path 
)

translate path from hdf5 to absolute path in external format
@rtype:  string
@return: absolute path in external format

Definition at line 87 of file h5fs.py.

def hdf5fs.h5fs.H5fs.refdir (   self,
  path 
)

translate path to a tuple of (group_ref, relpath)
@type  path:  string
@param path:  the path of the object
@rtype:   tuple
@return: (group_ref, relpath)
  - group_ref: PyCObject that refers to a H5:Group object in which relpath is relevant
  - relpath:  relative path inside the group refered to by group_ref

Definition at line 96 of file h5fs.py.

def hdf5fs.h5fs.H5fs.refdir2 (   self,
  path1,
  path2 
)

Definition at line 110 of file h5fs.py.

def hdf5fs.h5fs.H5fs.chdir (   self,
  path 
)

open directory specified by 'path'

Definition at line 122 of file h5fs.py.

def hdf5fs.h5fs.H5fs.exists (   self,
  path 
)

Definition at line 132 of file h5fs.py.

def hdf5fs.h5fs.H5fs.makedirs (   self,
  path 
)

Definition at line 140 of file h5fs.py.

def hdf5fs.h5fs.H5fs.mkdir (   self,
  path 
)

make a new directory at location specified by 'path'

Definition at line 154 of file h5fs.py.

def hdf5fs.h5fs.H5fs.link (   self,
  path,
  newpath 
)

link(path, newpath) --> make a link at newpath to path

Definition at line 161 of file h5fs.py.

def hdf5fs.h5fs.H5fs.symlink (   self,
  path,
  newpath 
)

symlink(path, newpath) --> make a symbolic link at newpath to path

Definition at line 168 of file h5fs.py.

def hdf5fs.h5fs.H5fs.rename (   self,
  path,
  newpath 
)

rename(path, newpath) --> rename an object at path to newpath

Definition at line 175 of file h5fs.py.

def hdf5fs.h5fs.H5fs.mount (   self,
  path,
  fs 
)

mount(path, fs) --> mount fs to path of current 'file system'

Definition at line 182 of file h5fs.py.

def hdf5fs.h5fs.H5fs.open (   self,
  path,
  type = None,
  space = None,
  compression = 0,
  chunksize = 100 
)

open the given path in the current file
    - If type is not specified
    depends on the type of the opened item, it returns instance of different
    types.
- if it is a directory(group), return instance of h5dir.H5dir
- if it is a file(dataset), return instance of h5file.H5file
- if it is a type???, return instance of h5type.H5type

    - If type is specified
    then a new file (dataset) will be created and returned!

Definition at line 189 of file h5fs.py.

def hdf5fs.h5fs.H5fs.unlink (   self,
  path 
)

unlink(path) --> remove the object at given path

Definition at line 219 of file h5fs.py.

def hdf5fs.h5fs.H5fs.rmdir (   self,
  path 
)

rmdir(path) --> remove the directory at the given path

Definition at line 226 of file h5fs.py.

def hdf5fs.h5fs.H5fs.umount (   self,
  path 
)

unmount(path) --> remove the mounted fs at the given path

Definition at line 233 of file h5fs.py.

def hdf5fs.h5fs.H5fs.stat (   self,
  path 
)

stat(path) --> status of the object at the given path
- return:    a dictionary of descriptions of the status
     {'type':???, 'numlinks':???}

Definition at line 240 of file h5fs.py.

def hdf5fs.h5fs.H5fs.__init__ (   self,
  filename,
  mode 
)

H5fs(filename, mode) -> create new H5fs
Recognized modes: 'r' (read-only), 'w' (write-append),
'c' (create/truncate-existing)

Definition at line 249 of file h5fs.py.


Member Data Documentation

hdf5fs.h5fs.H5fs.cwdref

Definition at line 126 of file h5fs.py.

hdf5fs.h5fs.H5fs.cwd

Definition at line 127 of file h5fs.py.

hdf5fs.h5fs.H5fs.type

Definition at line 253 of file h5fs.py.

hdf5fs.h5fs.H5fs.rootref

Definition at line 255 of file h5fs.py.

hdf5fs.h5fs.H5fs.dirsep

Definition at line 262 of file h5fs.py.

hdf5fs.h5fs.H5fs.slashrep

Definition at line 264 of file h5fs.py.

hdf5fs.h5fs.H5fs.autodir

Definition at line 266 of file h5fs.py.

hdf5fs.h5fs.H5fs.autocd

Definition at line 268 of file h5fs.py.


The documentation for this class was generated from the following file:
Generated on Mon Jun 22 01:31:04 2009 for hdf5fs by  doxygen 1.5.2