/usr/include/casacore/casa/HDF5/HDF5File.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 | //# HDF5File.h: An class representing an HDF5 file
//# 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_HDF5FILE_H
#define CASA_HDF5FILE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/HDF5/HDF5Object.h>
#include <casacore/casa/BasicSL/String.h>
#include <casacore/casa/IO/ByteIO.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// A class representing an HDF5 file.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tHDF5File.cc">
// </reviewed>
// <prerequisite>
// <li> <a href="http://hdf.ncsa.uiuc.edu">HDF5 system</a>
// </prerequisite>
// <synopsis>
// This class wraps the HDF5 functions to open, create, or close an
// HDF5 file.
// If the file is opened as readonly, it is possible to reopen it for
// read/write (provided the user has the correct privileges).
// It is also possible to temporarily close the file and reopen it later.
// <note> It is ensured that the class and the static function <tt>isHDF5</tt>
// are also defined if HDF5 is not compiled in. </note>
// </synopsis>
// <motivation>
// It was overkill to use the HDF5 C++ interface. Instead little wrappers
// have been written. HDF5File can be embedded in a shared pointer making
// it possible to share an HDF5 file amongst various HDF5Array objects.
// </motivation>
class HDF5File : public HDF5Object
{
public:
// Create an HDF5 file object with the given file name (possible tilde
// or environment variables in it will be expanded).
// The ByteIO option determines if the file will be created,
// opened for input and/or output, or possibly deleted by the destructor.
explicit HDF5File (const String& name,
ByteIO::OpenOption = ByteIO::Old);
// The destructor closes the file and deletes it when it was opened
// using ByteIO::Scratch or ByteIO::Delete.
~HDF5File();
// Test if the file with the given name is an HDF5 file.
static Bool isHDF5 (const String& name);
// Reopen the underlying file for read/write access.
// Nothing will be done if the stream is writable already.
// Otherwise it will be reopened and an exception will be thrown
// if it is not possible to reopen it for read/write access.
void reopenRW();
// Is the file writable?
Bool isWritable() const
{ return itsOption == ByteIO::Update; }
// Is the file opened for delete?
Bool isOpenedForDelete() const
{ return itsDelete; }
// Is the file temporarily closed?
Bool isClosed() const
{ return getHid()<0; }
// Close the file (temporarily).
// Note it will not delete the file; that is only done by the destructor.
virtual void close();
// Reopen the file if closed (which may change the HID).
void reopen();
// Flush the data to disk.
void flush();
// Get or set the chunk cache size (in bytes).
// Note that all data sets in a file share the cache.
// <group>
size_t getChunkCacheSize() const;
void setChunkCacheSize (size_t nbytes);
// </group>
private:
// Open or create the file.
void doOpen();
//# Data members
ByteIO::OpenOption itsOption;
String itsName;
Bool itsDelete;
private:
// Copy constructor cannot be used.
HDF5File (const HDF5File& that);
// Assignment cannot be used.
HDF5File& operator= (const HDF5File& that);
};
}
#endif
|