/usr/include/casacore/casa/HDF5/HDF5Object.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | //# HDF5Object.h: An abstract base class representing an HDF5 object
//# Copyright (C) 2008
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef CASA_HDF5OBJECT_H
#define CASA_HDF5OBJECT_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/String.h>
//# Define hid_t and hsize_t if not defined (thus if HDF5 disabled).
//# They should be the same as used by HDF5.
//# This is checked by functions check_hid_t and check_hsize_t.
#ifdef HAVE_HDF5
# include <hdf5.h>
#else
typedef int hid_t;
typedef unsigned long long hsize_t;
#endif
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// Define 2 functions to check that hid_t and hsize_t are mapped correctly.
// They are called by the constructor, so the compiler will scream if
// incorrect.
// <group>
void throwInvHDF5();
inline void check_hid_t (int) {}
template<typename T> inline void check_hid_t (T) {throwInvHDF5();}
inline void check_hsize_t (unsigned long long) {}
template<typename T> inline void check_hsize_t (T) {throwInvHDF5();}
// </group>
// <summary>
// An abstract base class representing an HDF5 object
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tHDF5Dataset.cc">
// </reviewed>
// <synopsis>
// This class wraps a basic HDF5 object. It offers several benefits:
// <ul>
// <li> The most important is resource management. In case of an exception,
// the object's hid will automatically be closed by the destructor.
// <li> It acts as the base class for the basic objects file, group,
// and dataset.
// <li> An HDF5 hid is a kind of pointer and should not be copied.
// These classes forbid making a copy, but make it possible to use
// them in a shared pointer context.
// </ul>
// </synopsis>
class HDF5Object
{
public:
// Default constructor sets to invalid hid.
HDF5Object()
: itsHid(-1)
{
check_hid_t (hid_t(0));
check_hsize_t (hsize_t(0));
}
// The destructor in a derived class should close the hid appropriately.
virtual ~HDF5Object();
// Check if there is HDF5 support compiled in.
static Bool hasHDF5Support();
// Close the hid if valid.
virtual void close() = 0;
// Is it a valid hid?
bool isValid() const
{ return itsHid >= 0; }
// Get the hid.
hid_t getHid() const
{ return itsHid; }
// Convert automatically to hid_t.
operator hid_t() const
{ return itsHid; }
// Get or set the name.
// <group>
void setName (const String& name)
{ itsName = name; }
const String& getName() const
{ return itsName; }
// </group>
// If no HDF5, throw an exception that HDF5 is not supported.
static void throwNoHDF5();
protected:
// Set the hid.
void setHid (hid_t hid)
{ itsHid = hid; }
// Clear the hid (set to invalid).
void clearHid()
{ itsHid = -1; }
private:
//# Data members
hid_t itsHid;
String itsName;
private:
// Copy constructor cannot be used.
HDF5Object (const HDF5Object& that);
// Assignment cannot be used.
HDF5Object& operator= (const HDF5Object& that);
};
}
#endif
|