A class representing an HDF5 property hid. More...

#include <HDF5HidMeta.h>

Public Member Functions
	HDF5HidProperty ()
	Default constructor sets hid to invalid.
	HDF5HidProperty (hid_t hid)
	Construct from given hid.
	~HDF5HidProperty ()
	The destructor closes the hid.
void	close ()
	Close the hid if valid.
void	operator= (hid_t hid)
	Put hid in it.
hid_t	getHid () const
	Get the hid.
	operator hid_t () const
	Convert automatically to hid_t.
Private Member Functions
	HDF5HidProperty (const HDF5HidProperty &that)
	Copy constructor cannot be used.
HDF5HidProperty &	operator= (const HDF5HidProperty &that)
	Assignment cannot be used.
Private Attributes
hid_t	itsHid

Detailed Description

A class representing an HDF5 property hid.

Intended use:

Internal

Review Status

Test programs:: tHDF5Dataset

Synopsis

This class wraps an HDF5 property 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 forbid making a copy, but make it possible to use them in a shared pointer context.

Definition at line 52 of file HDF5HidMeta.h.

Constructor & Destructor Documentation

casa::HDF5HidProperty::HDF5HidProperty ( ) [inline]

Default constructor sets hid to invalid.

Definition at line 56 of file HDF5HidMeta.h.

casa::HDF5HidProperty::HDF5HidProperty ( hid_t hid ) [inline]

Construct from given hid.

Definition at line 59 of file HDF5HidMeta.h.

casa::HDF5HidProperty::~HDF5HidProperty ( ) [inline]

The destructor closes the hid.

Definition at line 62 of file HDF5HidMeta.h.

References close().

casa::HDF5HidProperty::HDF5HidProperty ( const HDF5HidProperty & that ) [private]

Copy constructor cannot be used.

Member Function Documentation

void casa::HDF5HidProperty::close ( )

Close the hid if valid.

Referenced by operator=(), and ~HDF5HidProperty().

hid_t casa::HDF5HidProperty::getHid ( ) const [inline]

Get the hid.

Definition at line 70 of file HDF5HidMeta.h.

References itsHid.

casa::HDF5HidProperty::operator hid_t ( ) const [inline]

Convert automatically to hid_t.

Definition at line 73 of file HDF5HidMeta.h.

References itsHid.

HDF5HidProperty& casa::HDF5HidProperty::operator= ( const HDF5HidProperty & that ) [private]

Assignment cannot be used.

void casa::HDF5HidProperty::operator= ( hid_t hid ) [inline]

Put hid in it.

If it already contains a hid, it will be closed.

Definition at line 67 of file HDF5HidMeta.h.

References close(), and itsHid.

Member Data Documentation

hid_t casa::HDF5HidProperty::itsHid [private]

Definition at line 81 of file HDF5HidMeta.h.

Referenced by getHid(), operator hid_t(), and operator=().

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

casa/HDF5/HDF5HidMeta.h

casa::HDF5HidProperty Class Reference [HDF5_module_internal_classes]

Public Member Functions

Private Member Functions

Private Attributes