casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::HDF5HidProperty Class Reference

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

#include <HDF5HidMeta.h>

Public Member Functions

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

 HDF5HidProperty (const HDF5HidProperty &that)
 Copy constructor cannot be used. More...
HDF5HidPropertyoperator= (const HDF5HidProperty &that)
 Assignment cannot be used. More...

Private Attributes

hid_t itsHid

Detailed Description

A class representing an HDF5 property hid.

Intended use:


Review Status

Test programs:


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

Definition at line 53 of file HDF5HidMeta.h.

Constructor & Destructor Documentation

casacore::HDF5HidProperty::HDF5HidProperty ( )

Default constructor sets hid to invalid.

Definition at line 57 of file HDF5HidMeta.h.

casacore::HDF5HidProperty::HDF5HidProperty ( hid_t  hid)

Construct from given hid.

Definition at line 60 of file HDF5HidMeta.h.

casacore::HDF5HidProperty::~HDF5HidProperty ( )

The destructor closes the hid.

Definition at line 63 of file HDF5HidMeta.h.

References close().

casacore::HDF5HidProperty::HDF5HidProperty ( const HDF5HidProperty that)

Copy constructor cannot be used.

Member Function Documentation

void casacore::HDF5HidProperty::close ( )

Close the hid if valid.

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

hid_t casacore::HDF5HidProperty::getHid ( ) const

Get the hid.

Definition at line 71 of file HDF5HidMeta.h.

References itsHid.

casacore::HDF5HidProperty::operator hid_t ( ) const

Convert automatically to hid_t.

Definition at line 74 of file HDF5HidMeta.h.

References itsHid.

void casacore::HDF5HidProperty::operator= ( hid_t  hid)

Put hid in it.

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

Definition at line 68 of file HDF5HidMeta.h.

References close(), and itsHid.

HDF5HidProperty& casacore::HDF5HidProperty::operator= ( const HDF5HidProperty that)

Assignment cannot be used.

Member Data Documentation

hid_t casacore::HDF5HidProperty::itsHid

Definition at line 82 of file HDF5HidMeta.h.

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

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