/usr/include/casacore/lattices/Lattices/HDF5LattIter.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 | //# HDF5LattIter.h: a concrete iterator for use with HDF5Lattices.
//# Copyright (C) 2009
//# 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 LATTICES_HDF5LATTITER_H
#define LATTICES_HDF5LATTITER_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/Lattices/LatticeIterInterface.h>
#include <casacore/lattices/Lattices/HDF5Lattice.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// A read/write Lattice iterator for PagedArrays.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Peter Barnes" date="1999/10/30" tests="tLatticeIterator.cc" demos="dPagedArray.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto class="PagedArray">PagedArray</linkto>
// <li> <linkto class="LatticeIterator">LatticeIterator</linkto>
// <li> <linkto class="LatticeIterInterface">LatticeIterInterface
// </linkto>
// <li> letter/envelope schemes, eg. Coplien, "Advanced C++", ch 5.5
// </prerequisite>
// <etymology>
// The HDF5LattIter class name is a contraction of Paged Array Iterator
// and reflects its role as the methods for iterating through Lattices which
// are resident on disk.
// </etymology>
// <synopsis>
// This class is not meant for general use. Instead class
// <linkto class="LatticeIterator">LatticeIterator</linkto> should be used
// to iterate through a <src>PagedArray</src> or any other
// <linkto class="Lattice">Lattice</linkto> object
// (like a <linkto class="ArrayLattice">ArrayLattice</linkto>).
// <p>
// HDF5LattIter is derived from LatticeIterInterface and implements
// the iterator for a <linkto class=PagedArray>PagedArray</linkto>
// object. This iterator is somewhat special because it sets the
// PagedArray cache size at the start of an iteration.
// </synopsis>
// <motivation>
// For for each derivation of Lattice to make as efficient an iterator as
// possible.
// The letter/envelope scheme allowed us to hide the special bits in
// classes like the one you see here.
// </motivation>
// <templating arg=T>
// <li> Restricted to the type of the PagedArray argument in the
// constructors
// </templating>
//# <todo asof="1997/01/31">
//# <li>
//# </todo>
template <class T> class HDF5LattIter : public LatticeIterInterface<T>
{
friend class HDF5Lattice<T>;
//# Make members of parent class known.
protected:
using LatticeIterInterface<T>::rewriteData;
using LatticeIterInterface<T>::itsNavPtr;
protected:
// Construct the Iterator with the supplied data, and iteration strategy
HDF5LattIter (const HDF5Lattice<T>& data, const LatticeNavigator& method,
Bool useRef);
// The copy constructor uses reference sematics for the PagedArray and
// copy semantics for the cursor and Navigator. This way the newly
// constructed HDF5LattIter can independently iterate through the same
// data set. (with the same cursor shape etc.)
HDF5LattIter (const HDF5LattIter<T>& other);
// Destructor (cleans up dangling references and releases cursor memory)
virtual ~HDF5LattIter();
// The assignment operator uses reference sematics for the PagedArray and
// copy semantics for the cursor and Navigator. This way the
// HDF5LattIter objects share the same data set but independently iterate
// with cursors of the same size.
HDF5LattIter<T>& operator= (const HDF5LattIter<T>& other);
// Clone the object.
virtual LatticeIterInterface<T>* clone() const;
private:
// Setup the cache in the tiled storage manager.
void setupTileCache();
// reference to the PagedArray
HDF5Lattice<T> itsData;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/Lattices/HDF5LattIter.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|