/usr/include/casacore/tables/DataMan/TSMCubeBuff.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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | //# TSMCubeBuff.h: Tiled hypercube in a table
//# 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 TABLES_TSMCUBEBUFF_H
#define TABLES_TSMCUBEBUFF_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/TSMCube.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
class BucketBuffered;
// <summary>
// Tiled hypercube in a table
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> <linkto class=TiledStMan>TiledStMan</linkto>
// <li> <linkto class=ROTiledStManAccessor>ROTiledStManAccessor</linkto>
// for a discussion of the maximum cache size
// <li> <linkto class=TSMFile>TSMFile</linkto>
// <li> <linkto class=BucketBuffered>BucketBuffered</linkto>
// </prerequisite>
// <etymology>
// TSMCubeBuff represents a hypercube in the Tiled Storage Manager.
// </etymology>
// <synopsis>
// TSMCubeBuff defines a tiled hypercube. The data is stored in a TSMFile
// object and accessed using a BucketBuffered object. The hypercube can
// be extensible in its last dimension to support tables with a size
// which is not known in advance.
// <br>
// Normally hypercubes share the same TSMFile object, but extensible
// hypercubes have their own TSMFile object (to be extensible).
// If the hypercolumn has multiple data columns, their cells share the same
// tiles. Per tile data column A appears first, thereafter B, etc..
// <br>
// The data in the cache is held in external format and is converted
// when accessed. The alternative would be to hold it in the cache in
// local format and convert it when read/written from the file. It was
// felt that the latter approach would generate more needless conversions.
// <p>
// The possible id and coordinate values are stored in a Record
// object. They are written in the main hypercube AipsIO file.
// <p>
// TSMCubeBuff uses the maximum cache size set for a Tiled Storage manager.
// The description of class
// <linkto class=ROTiledStManAccessor>ROTiledStManAccessor</linkto>
// contains a discussion about the effect of setting the maximum cache size.
// </synopsis>
// <motivation>
// TSMCubeBuff encapsulates all operations on a hypercube.
// </motivation>
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class TSMCubeBuff: public TSMCube
{
public:
// Construct the hypercube using the given file with the given shape.
// The record contains the id and possible coordinate values.
// <br>If the cubeshape is empty, the hypercube is still undefined and
// can be added later with setShape. That is only used by TiledCellStMan.
// <br> The fileOffset argument is meant for class TiledFileAccess.
TSMCubeBuff (TiledStMan* stman, TSMFile* file,
const IPosition& cubeShape,
const IPosition& tileShape,
const Record& values, Int64 fileOffset, uInt bufferSize);
// Reconstruct the hypercube by reading its data from the AipsIO stream.
// It will link itself to the correct TSMFile. The TSMFile objects
// must have been reconstructed in advance.
TSMCubeBuff (TiledStMan* stman, AipsIO& ios, uInt bufferSize);
virtual ~TSMCubeBuff();
// Flush the data in the cache.
virtual void flushCache();
// Show the cache statistics.
virtual void showCacheStatistics (ostream& os) const;
// Set the hypercube shape.
// This is only possible if the shape was not defined yet.
virtual void setShape (const IPosition& cubeShape,
const IPosition& tileShape);
// Extend the last dimension of the cube with the given number.
// The record can contain the coordinates of the elements added.
virtual void extend (uInt nr, const Record& coordValues,
const TSMColumn* lastCoordColumn);
// Read or write a section in the cube.
// It is assumed that the section buffer is long enough.
virtual void accessSection (const IPosition& start, const IPosition& end,
char* section, uInt colnr,
uInt localPixelSize, uInt externalPixelSize,
Bool writeFlag);
// Read or write a section in a strided way.
// It is assumed that the section buffer is long enough.
virtual void accessStrided (const IPosition& start, const IPosition& end,
const IPosition& stride,
char* section, uInt colnr,
uInt localPixelSize, uInt externalPixelSize,
Bool writeFlag);
// Set the cache size for the given slice and access path.
virtual void setCacheSize (const IPosition& sliceShape,
const IPosition& windowStart,
const IPosition& windowLength,
const IPosition& axisPath,
Bool forceSmaller, Bool userSet);
// Resize the cache object.
// If forceSmaller is False, the cache will only be resized when it grows.
// If the given size exceeds the maximum size with more
// than 10%, the maximum size will be used.
// The cacheSize has to be given in buckets.
// <br>The flag <src>userSet</src> inidicates if the cache size is set by
// the user (by an Accessor object) or automatically (by TSMDataColumn).
virtual void setCacheSize (uInt cacheSize, Bool forceSmaller, Bool userSet);
private:
// Forbid copy constructor.
TSMCubeBuff (const TSMCubeBuff&);
// Forbid assignment.
TSMCubeBuff& operator= (const TSMCubeBuff&);
// Get the cache object.
// This will construct the cache object if not present yet.
BucketBuffered* getCache();
// Construct the cache object (if not constructed yet).
virtual void makeCache();
// Resync the cache object.
virtual void resyncCache();
// Delete the cache object.
virtual void deleteCache();
//# Declare member variables.
// The bucket cache.
BucketBuffered* cache_p;
// The buffer size to use.
uInt bufferSize_p;
};
inline BucketBuffered* TSMCubeBuff::getCache()
{
if (cache_p == 0) {
makeCache();
}
return cache_p;
}
} //# NAMESPACE CASACORE - END
#endif
|