casacore::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 151 of file HDF5HidMeta.h.


Constructor & Destructor Documentation

casacore::HDF5HidDataSpace::HDF5HidDataSpace (  )  [inline]

Default constructor sets hid to invalid.

Definition at line 155 of file HDF5HidMeta.h.

casacore::HDF5HidDataSpace::HDF5HidDataSpace ( hid_t  hid  )  [inline]

Construct from given hid.

Definition at line 158 of file HDF5HidMeta.h.

casacore::HDF5HidDataSpace::~HDF5HidDataSpace (  )  [inline]

The destructor closes the hid.

Definition at line 161 of file HDF5HidMeta.h.

References close().

casacore::HDF5HidDataSpace::HDF5HidDataSpace ( const HDF5HidDataSpace that  )  [private]

Copy constructor cannot be used.


Member Function Documentation

void casacore::HDF5HidDataSpace::close (  ) 

Close the hid if valid.

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

hid_t casacore::HDF5HidDataSpace::getHid (  )  const [inline]

Get the hid.

Definition at line 169 of file HDF5HidMeta.h.

References itsHid.

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

Convert automatically to hid_t.

Definition at line 172 of file HDF5HidMeta.h.

References itsHid.

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

Assignment cannot be used.

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

Put hid in it.

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

Definition at line 166 of file HDF5HidMeta.h.

References close(), and itsHid.


Member Data Documentation

Definition at line 180 of file HDF5HidMeta.h.

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


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1