casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::HDF5Object Class Referenceabstract

An abstract base class representing an HDF5 object. More...

#include <HDF5Object.h>

Inheritance diagram for casacore::HDF5Object:
casacore::HDF5DataSet casacore::HDF5File casacore::HDF5Group

Public Member Functions

 HDF5Object ()
 Default constructor sets to invalid hid. More...
 
virtual ~HDF5Object ()
 The destructor in a derived class should close the hid appropriately. More...
 
virtual void close ()=0
 Close the hid if valid. More...
 
bool isValid () const
 Is it a valid hid? More...
 
hid_t getHid () const
 Get the hid. More...
 
 operator hid_t () const
 Convert automatically to hid_t. More...
 
void setName (const String &name)
 Get or set the name. More...
 
const StringgetName () const
 

Static Public Member Functions

static Bool hasHDF5Support ()
 Check if there is HDF5 support compiled in. More...
 
static void throwNoHDF5 ()
 If no HDF5, throw an exception that HDF5 is not supported. More...
 

Protected Member Functions

void setHid (hid_t hid)
 Set the hid. More...
 
void clearHid ()
 Clear the hid (set to invalid). More...
 

Private Member Functions

 HDF5Object (const HDF5Object &that)
 Copy constructor cannot be used. More...
 
HDF5Objectoperator= (const HDF5Object &that)
 Assignment cannot be used. More...
 

Private Attributes

union {
   hid_t   itsHid
 
   int64_t   itsDummyHid
 
}; 
 
String itsName
 

Detailed Description

An abstract base class representing an HDF5 object.

Intended use:

Public interface

Review Status

Test programs:
tHDF5Dataset

Synopsis

This class wraps a basic HDF5 object. It offers several benefits:

Definition at line 70 of file HDF5Object.h.

Constructor & Destructor Documentation

casacore::HDF5Object::HDF5Object ( )
inline

Default constructor sets to invalid hid.

Definition at line 74 of file HDF5Object.h.

virtual casacore::HDF5Object::~HDF5Object ( )
virtual

The destructor in a derived class should close the hid appropriately.

casacore::HDF5Object::HDF5Object ( const HDF5Object that)
private

Copy constructor cannot be used.

Member Function Documentation

void casacore::HDF5Object::clearHid ( )
inlineprotected

Clear the hid (set to invalid).

Definition at line 116 of file HDF5Object.h.

References itsHid.

virtual void casacore::HDF5Object::close ( )
pure virtual

Close the hid if valid.

Implemented in casacore::HDF5DataSet, casacore::HDF5File, and casacore::HDF5Group.

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

Get the hid.

Definition at line 92 of file HDF5Object.h.

References itsHid.

Referenced by casacore::HDF5File::isClosed().

const String& casacore::HDF5Object::getName ( ) const
inline

Definition at line 103 of file HDF5Object.h.

References itsName.

Referenced by casacore::HDF5Group::HDF5Group().

static Bool casacore::HDF5Object::hasHDF5Support ( )
static

Check if there is HDF5 support compiled in.

Referenced by casacore::canUseHDF5Image().

bool casacore::HDF5Object::isValid ( ) const
inline

Is it a valid hid?

Definition at line 88 of file HDF5Object.h.

References itsHid.

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

Convert automatically to hid_t.

Definition at line 96 of file HDF5Object.h.

References itsHid.

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

Assignment cannot be used.

void casacore::HDF5Object::setHid ( hid_t  hid)
inlineprotected

Set the hid.

Definition at line 112 of file HDF5Object.h.

References itsHid.

void casacore::HDF5Object::setName ( const String name)
inline

Get or set the name.

Definition at line 101 of file HDF5Object.h.

References itsName.

static void casacore::HDF5Object::throwNoHDF5 ( )
static

If no HDF5, throw an exception that HDF5 is not supported.

Member Data Documentation

union { ... }
int64_t casacore::HDF5Object::itsDummyHid

Definition at line 125 of file HDF5Object.h.

hid_t casacore::HDF5Object::itsHid

Definition at line 124 of file HDF5Object.h.

Referenced by clearHid(), getHid(), isValid(), operator hid_t(), and setHid().

String casacore::HDF5Object::itsName
private

Definition at line 127 of file HDF5Object.h.

Referenced by getName(), and setName().


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