casacore::HDF5Group Class Reference

A class representing an HDF5 group. More...

#include <HDF5Group.h>

Inheritance diagram for casacore::HDF5Group:

Public Member Functions
	HDF5Group ()
	Construct from given hid.
	HDF5Group (const HDF5Object &parentHid, const String &name, bool mustExist=false, bool mustNotExist=false)
	Open or create a group at the given hid.
	HDF5Group (hid_t parentHid, const String &name, bool mustExist=false, bool mustNotExist=false)
virtual	~HDF5Group ()
	The destructor closes the hid.
virtual void	close ()
	Close the hid if valid.
Static Public Member Functions
static std::vector< String >	linkNames (const HDF5Object &parentHid)
	Get the names of all links at the given hid.
static bool	exists (const HDF5Object &parentHid, const String &name)
	Test if the group at the given hid exists.
static void	remove (const HDF5Object &parentHid, const String &name)
	Delete group at the given hid if it exists.
Private Member Functions
	HDF5Group (const HDF5Group &that)
	Copy constructor cannot be used.
HDF5Group &	operator= (const HDF5Group &that)
	Assignment cannot be used.
void	init (hid_t parentHid, const String &parentName, const String &name, bool mustExist=false, bool mustNotExist=false)
	Initialize (execute the constructor).

Detailed Description

A class representing an HDF5 group.

Intended use:

Public interface

Review Status

Test programs:: tHDF5Dataset

Synopsis

This class wraps an HDF5 group hid (hdf5 id). It offers two benefits:

The most important is resource management. In case of an exception, the hid will automatically be closed by the destructor.
A hid is a kind of pointer and should not be copied. These classes make it possible to use them in a shared pointer.

Definition at line 54 of file HDF5Group.h.

Constructor & Destructor Documentation

casacore::HDF5Group::HDF5Group ( ) [inline]

Construct from given hid.

Definition at line 58 of file HDF5Group.h.

casacore::HDF5Group::HDF5Group	(	const HDF5Object &	parentHid,
		const String &	name,
		bool	mustExist = `false`,
		bool	mustNotExist = `false`
	)			`[inline]`

Open or create a group at the given hid.

Default is that the group may exist; it is created if not existing.

Definition at line 64 of file HDF5Group.h.

References casacore::HDF5Object::getName(), and init().

casacore::HDF5Group::HDF5Group	(	hid_t	parentHid,
		const String &	name,
		bool	mustExist = `false`,
		bool	mustNotExist = `false`
	)			`[inline]`

Definition at line 68 of file HDF5Group.h.

References init(), and String.

virtual casacore::HDF5Group::~HDF5Group ( ) [virtual]

The destructor closes the hid.

casacore::HDF5Group::HDF5Group ( const HDF5Group & that ) [private]

Copy constructor cannot be used.

Member Function Documentation

virtual void casacore::HDF5Group::close ( ) [virtual]

Close the hid if valid.

Implements casacore::HDF5Object.

static bool casacore::HDF5Group::exists	(	const HDF5Object &	parentHid,
		const String &	name
	)			`[static]`

Test if the group at the given hid exists.

void casacore::HDF5Group::init	(	hid_t	parentHid,
		const String &	parentName,
		const String &	name,
		bool	mustExist = `false`,
		bool	mustNotExist = `false`
	)			`[private]`

Initialize (execute the constructor).

Referenced by HDF5Group().

static std::vector<String> casacore::HDF5Group::linkNames ( const HDF5Object & parentHid ) [static]

Get the names of all links at the given hid.

HDF5Group& casacore::HDF5Group::operator= ( const HDF5Group & that ) [private]

Assignment cannot be used.

Reimplemented from casacore::HDF5Object.

static void casacore::HDF5Group::remove	(	const HDF5Object &	parentHid,
		const String &	name
	)			`[static]`

Delete group at the given hid if it exists.

The documentation for this class was generated from the following file:

casacore/casa/HDF5/HDF5Group.h