Loading...
Searching...
No Matches
HDF5LattIter.h
Go to the documentation of this file.
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#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
casacore::HDF5LattIter::clone
virtual LatticeIterInterface< T > * clone() const
Clone the object.
casacore::HDF5LattIter::setupTileCache
void setupTileCache()
Setup the cache in the tiled storage manager.
casacore::HDF5LattIter::operator=
HDF5LattIter< T > & operator=(const HDF5LattIter< T > &other)
The assignment operator uses reference sematics for the PagedArray and copy semantics for the cursor ...
casacore::HDF5LattIter::HDF5LattIter
HDF5LattIter(const HDF5Lattice< T > &data, const LatticeNavigator &method, Bool useRef)
Construct the Iterator with the supplied data, and iteration strategy.
casacore::HDF5LattIter::~HDF5LattIter
virtual ~HDF5LattIter()
Destructor (cleans up dangling references and releases cursor memory).
casacore::HDF5LattIter::HDF5LattIter
HDF5LattIter(const HDF5LattIter< T > &other)
The copy constructor uses reference sematics for the PagedArray and copy semantics for the cursor and...
casacore::HDF5LattIter::itsData
HDF5Lattice< T > itsData
reference to the PagedArray
Definition HDF5LattIter.h:128
casacore::HDF5Lattice
Definition HDF5Lattice.h:108
casacore::LatticeIterInterface::itsNavPtr
LatticeNavigator * itsNavPtr
Pointer to the method of Lattice transversal.
Definition LatticeIterInterface.h:244
casacore::LatticeIterInterface::rewriteData
virtual void rewriteData()
Rewrite the cursor data and clear the rewrite flag.
casacore::LatticeIterInterface::LatticeIterInterface
LatticeIterInterface(const Lattice< T > &lattice, const LatticeNavigator &navigator, Bool useRef)
Construct with the given navigator.
casacore::LatticeNavigator
Definition LatticeNavigator.h:180
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40