casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::HDF5HidDataSpace Class Reference

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

#include <HDF5HidMeta.h>

Public Member Functions

 HDF5HidDataSpace ()
 Default constructor sets hid to invalid. More...
 
 HDF5HidDataSpace (hid_t hid)
 Construct from given hid. More...
 
 ~HDF5HidDataSpace ()
 The destructor closes the hid. More...
 
void close ()
 Close the hid if valid. More...
 
void operator= (hid_t hid)
 Put hid in it. More...
 
hid_t getHid () const
 Get the hid. More...
 
 operator hid_t () const
 Convert automatically to hid_t. More...
 

Private Member Functions

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

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

◆ HDF5HidDataSpace() [1/3]

casacore::HDF5HidDataSpace::HDF5HidDataSpace ( )
inline

Default constructor sets hid to invalid.

Definition at line 154 of file HDF5HidMeta.h.

◆ HDF5HidDataSpace() [2/3]

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

Construct from given hid.

Definition at line 157 of file HDF5HidMeta.h.

◆ ~HDF5HidDataSpace()

casacore::HDF5HidDataSpace::~HDF5HidDataSpace ( )
inline

The destructor closes the hid.

Definition at line 160 of file HDF5HidMeta.h.

References close().

◆ HDF5HidDataSpace() [3/3]

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

Copy constructor cannot be used.

Member Function Documentation

◆ close()

void casacore::HDF5HidDataSpace::close ( )

Close the hid if valid.

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

◆ getHid()

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

Get the hid.

Definition at line 168 of file HDF5HidMeta.h.

References itsHid.

◆ operator hid_t()

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

Convert automatically to hid_t.

Definition at line 171 of file HDF5HidMeta.h.

References itsHid.

◆ operator=() [1/2]

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

Assignment cannot be used.

◆ operator=() [2/2]

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 165 of file HDF5HidMeta.h.

References close(), and itsHid.

Member Data Documentation

◆ itsHid

hid_t casacore::HDF5HidDataSpace::itsHid
private

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: