casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes
casa::HDF5HidDataSpace Class Reference

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

#include <HDF5HidMeta.h>

List of all members.

Public Member Functions

 HDF5HidDataSpace ()
 Default constructor sets hid to invalid.
 HDF5HidDataSpace (hid_t hid)
 Construct from given hid.
 ~HDF5HidDataSpace ()
 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

 HDF5HidDataSpace (const HDF5HidDataSpace &that)
 Copy constructor cannot be used.
HDF5HidDataSpaceoperator= (const HDF5HidDataSpace &that)
 Assignment cannot be used.

Private Attributes

hid_t itsHid

Detailed Description

 A class representing an HDF5 dataspace hid.

Intended use:

Internal

Review Status

Test programs:
tHDF5Dataset

Synopsis

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

Definition at line 150 of file HDF5HidMeta.h.


Constructor & Destructor Documentation

Default constructor sets hid to invalid.

Definition at line 154 of file HDF5HidMeta.h.

Construct from given hid.

Definition at line 157 of file HDF5HidMeta.h.

The destructor closes the hid.

Definition at line 160 of file HDF5HidMeta.h.

References close().

Copy constructor cannot be used.


Member Function Documentation

Close the hid if valid.

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

Get the hid.

Definition at line 168 of file HDF5HidMeta.h.

References itsHid.

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

Convert automatically to hid_t.

Definition at line 171 of file HDF5HidMeta.h.

References itsHid.

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

Put hid in it.

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

Definition at line 165 of file HDF5HidMeta.h.

References close(), and itsHid.

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

Assignment cannot be used.


Member Data Documentation

Definition at line 179 of file HDF5HidMeta.h.

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


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