casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Modules | Classes

Classes binding casacore to the HDF5 C API. More...

Modules

 HDF5_module_internal_classes
 Internal HDF5_module classes and functions.
 

Classes

class  casacore::HDF5DataSet
 A class representing an HDF5 data set. More...
 
class  casacore::HDF5Error
 Base error class for HDF5 wrapper classes. More...
 
class  casacore::HDF5File
 A class representing an HDF5 file. More...
 
class  casacore::HDF5Group
 A class representing an HDF5 group. More...
 
class  casacore::HDF5Object
 An abstract base class representing an HDF5 object. More...
 
class  casacore::HDF5Record
 A class to write/read a record into HDF5. More...
 

Detailed Description

Classes binding casacore to the HDF5 C API.

See below for an overview of the classes in this module.

Prerequisite

Etymology

'HDF5' is version 5 of the Hierarchical Data Format.

Synopsis

This module's main purpose is to provide limited, but convenient access to the HDF5 C API. The classes offer the following services:

The following interface classes are available:

Note that HDF5Object forms the base class of HDF5File, HDF5Group, and HDF5DataSet. Most interfaces use HDF5Object, thus are applicable to all these object types.
An HDF5Object has a conversion operator to hid_t, thus can be used directly in any HDF5 function.

Because of HDF5 resource management the objects (e.g. HDF5File) cannot be copied. However, they can be used in shared pointers (like casacore's CountedPtr or std::shared_ptr).
Internally the classes use HDF5HidMeta.h which does the resource management for HDF5 meta data like attributes, property lists, etc..


Note: All HDF5 classes and all their functions are compiled, but it depends on the setting of HAVE_HDF5 how; If not set, all these functions are merely stubs and the class constructors throw an exception when used; The function HDF5Object::hasHDF5Support() tells if HDF5 is used; See the casacore build instructions at github;com/casacore/casacore for more information;

Example

See the various test programs.

Motivation

HDF5 offers a C++ interface. However, this interface is still quite complex and is too much C-oriented. Furthermore there was the need to support the casacore data types, in particular complex. The reversal of array axes was also needed.

To Do