tables.Leaf.Leaf

Package tables :: Module Leaf :: Class Leaf

[show private | hide private]

Type Leaf

object --+
         |
        Leaf

Known Subclasses:: Table

A class to place common functionality of all Leaf objects.

A Leaf object is all the nodes that can hang directly from a
Group, but that are not groups nor attributes. Right now this set
is composed by Table and Array objects.

Leaf objects (like Table or Array) will inherit the next methods
and variables using the mix-in technique.

Methods:

    close()
    flush()
    rename(newname)
    remove()
    getAttr(attrname)
    setAttr(attrname, attrvalue)
    delAttr(attrname)

Instance variables:

    name -- the leaf node name
    hdf5name -- the HDF5 leaf node name
    objectID -- the HDF5 object ID of the Leaf node
    title -- the leaf title (actually a property)
    shape -- the leaf shape
    byteorder -- the byteorder of the leaf
    filters -- information for active filters
    attrs -- The associated AttributeSet instance
    _v_parent -- the parent Group instance
    _v_rootgroup -- always point to the root group object
    _v_file -- the associated File object
    _v_depth -- the depth level in tree for this leaf

Method Summary
	`__len__(self)` Useful for dealing with Leaf objects as sequences
	`__str__(self)` The string reprsentation choosed for this object is its pathname in the HDF5 object tree.
	`close(self, flush)` Flush the buffers and close this object on tree
	`copy(self, where, name, title, filters, copyuserattrs, start, stop, step, overwrite)` Copy this leaf to other location where -- the group where the leaf will be copied.
	`delAttr(self, attrname)` Delete a leaf attribute as a string
	`flush(self)` Save whatever remaining data in buffer
	`getAttr(self, attrname)` Get a leaf attribute as a string
	`remove(self)` Remove a leaf
	`rename(self, newname)` Rename a leaf
	`setAttr(self, attrname, attrvalue)` Set a leaf attribute as a string
	`_g_getFilters(self)`
	`_g_putObjectInTree(self, name, parent)` Given a new Leaf object (fresh or in a HDF5 file), set links and attributes to include it in the object tree.
	`_g_renameObject(self, newname)` Rename this leaf in the object tree as well as in the HDF5 file.
	`_g_setFilters(self, filters)`
	`_get_attrs(self)`
	`_get_title(self)`
	`_set_title(self, title)`
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value

Property Summary
	`attrs`: Attrs of this object
	`title`: Title of this object

Method Details

len(self)
(Length operator)

Useful for dealing with Leaf objects as sequences

str(self)
(Informal representation operator)

The string reprsentation choosed for this object is its pathname in the HDF5 object tree.

Overrides:: __builtin__.object.__str__

close(self, flush=1)

Flush the buffers and close this object on tree

copy(self, where, name, title=None, filters=None, copyuserattrs=1, start=0, stop=None, step=1, overwrite=0)

Copy this leaf to other location

where -- the group where the leaf will be copied.
name -- the name of the new leaf.
title -- the new title for destination. If None, the original
    title is kept.
filters -- An instance of the Filters class. A None value means
    that the source properties are copied as is.
copyuserattrs -- Whether copy the user attributes of the source leaf
    to the destination or not. The default is copy them.
start -- the row to start copying.
stop -- the row to cease copying. None means last row.
step -- the increment of the row number during the copy
overwrite -- whether the destination should be overwritten or not.

delAttr(self, attrname)

Delete a leaf attribute as a string

flush(self)

Save whatever remaining data in buffer

getAttr(self, attrname)

Get a leaf attribute as a string

remove(self)

Remove a leaf

rename(self, newname)

Rename a leaf

setAttr(self, attrname, attrvalue)

Set a leaf attribute as a string

_g_putObjectInTree(self, name, parent)

Given a new Leaf object (fresh or in a HDF5 file), set links and attributes to include it in the object tree.

_g_renameObject(self, newname)

Rename this leaf in the object tree as well as in the HDF5 file.

Property Details

attrs

Attrs of this object

Get Method:: _get_attrs(self)

title

Title of this object

Get Method:: _get_title(self)
Set Method:: _set_title(self, title)

Generated by Epydoc 2.1 on Thu Apr 21 13:11:50 2005

http://epydoc.sf.net