Next: nodelist Up: Python Interface - PyHL Previous: Create module _pyhl

Library Reference

This module defines the IO access for reading/writing HDF5 files. The module implements two classes for building an HDF5 file representation. The nodelist class implements a list that should represent the file itself. The node class represents the items in the HDF5 file. The nodelist contain several node's for building the HDF5 file. You can use this interface to write Python programs that interfact with HDF5 files.

The module defines the following items:

$\begin{methoddesc}{is_file_hdf5}{filename} Checks whether \normalsize\textrm{\te... ...ename\/}} is an HDF5 file. Returns 1 if it is and 0 otherwise. \end{methoddesc}$

$\begin{classdesc}{nodelist}{} Return a new instance of the \texttt{nodelist} class. \end{classdesc}$

$\begin{classdesc}{node}{nodetype,nodename} Return a new instance of the \texttt{... ...he name of the node, for example \code{/group1/group2/dataset1}. \end{classdesc}$

$\begin{datadesc}{ATTRIBUTE_ID} When creating a \texttt{node} and using this value, the node will become an attribute node. \end{datadesc}$

$\begin{datadesc}{DATASET_ID} When creating a \texttt{node} and using this value, the node will become a dataset node. \end{datadesc}$

$\begin{datadesc}{GROUP_ID} When creating a \texttt{node} and using this value, the node will become a group node. \end{datadesc}$

$\begin{datadesc}{TYPE_ID} When creating a \texttt{node} and using this value, the node will become a datatype node. \end{datadesc}$

$\begin{funcdesc}{read_nodelist}{filename\optional{,from}} Read the HDF5 file \no... ... \texttt{nodelist} is returned, otherwise an exception is thrown. \end{funcdesc}$

2000-08-08