Go to the documentation of this file.
28 #ifndef TABLES_TILEDSTMAN_H
29 #define TABLES_TILEDSTMAN_H
33 #include <casacore/casa/aips.h>
34 #include <casacore/tables/DataMan/DataManager.h>
35 #include <casacore/casa/Containers/Block.h>
36 #include <casacore/casa/Arrays/IPosition.h>
37 #include <casacore/casa/OS/Conversion.h>
38 #include <casacore/casa/BasicSL/String.h>
49 template<
class T>
class Vector;
163 uInt maxNrPixelsPerTile = 32768);
167 uInt maxNrPixelsPerTile = 32768);
267 uInt& localTileLength)
const;
312 const char* external,
const Block<uInt>& externalOffset,
341 const String& dataTypeID);
344 const String& dataTypeID);
347 const String& dataTypeID);
393 Bool mustExist)
const;
409 const Record& values)
const;
417 const Record& values)
const;
429 const Record& values)
const;
void checkAddHypercube(const IPosition &cubeShape, const Record &values) const
Check if the hypercube to be added is correctly defined.
PtrBlock< TSMColumn * > idColSet_p
The assembly of all id columns.
Bool canReallocateColumns() const
The TiledStMan wants to do reallocateColumn.
void headerFileClose(AipsIO *headerFile)
Close the header file.
uInt nrCoordVector() const
Get the number of coordinate vectors.
uInt nhypercubes() const
Return the number of hypercubes.
Abstract base class for a data manager.
PtrBlock< TSMCube * > cubeSet_p
The assembly of all TSMCube objects.
A drop-in replacement for Block<T*>.
uInt nrdim_p
The dimensionality of the hypercolumn.
virtual TSMCube * singleHypercube()
Test if only one hypercube is used by this storage manager.
void initCoordinates(TSMCube *hypercube)
Initialize the new coordinates for the given cube.
uInt persMaxCacheSize_p
The persistent maximum cache size (in MiB) for a hypercube.
PtrBlock< TSMColumn * > dataColSet_p
const IPosition & hypercubeShape(uInt rownr) const
Get the hypercube shape of the data in the given row.
uInt getBindings(const Vector< String > &columnNames, PtrBlock< TSMColumn * > &colSet, Bool mustExist) const
Get the bindings of the columns with the given names.
uInt maximumCacheSize() const
Get the current maximum cache size (in MiB (MibiByte)).
void checkCoordinates(const PtrBlock< TSMColumn * > &coordColSet, const IPosition &cubeShape, const Record &values) const
Check if the coordinate values are correct.
TiledStMan()
Create a TiledStMan.
Abstract base class for a column in a data manager.
PtrBlock< TSMColumn * > coordColSet_p
The assembly of all coordinate columns.
uInt nrCoordVector_p
The number of vector coordinates.
DataManagerColumn * reallocateColumn(DataManagerColumn *column)
Reallocate the column object if it is part of this data manager.
TSMCube * getTSMCube(uInt hypercube)
virtual void open(uInt nrrow, AipsIO &)
Open the storage manager for an existing table.
int arrayDataType(int dataType) const
Convert the scalar data type to an array data type.
virtual TSMCube * getHypercube(uInt rownr, IPosition &position)=0
Get the hypercube in which the given row is stored.
Bool dataChanged_p
Has any data changed since the last flush?
virtual void setProperties(const Record &spec)
Modify data manager properties.
uInt cacheSize(uInt rownr) const
Get the current cache size (in buckets) for the hypercube in the given row.
void writeTile(char *external, const Block< uInt > &externalOffset, const char *local, const Block< uInt > &localOffset, uInt nrpixels)
Write a tile after converting the data to external format.
DataManagerColumn * makeDirArrColumn(const String &name, int dataType, const String &dataTypeID)
Create a direct array column.
PtrBlock< TSMColumn * > colSet_p
The assembly of all columns.
void setCacheSize(uInt rownr, uInt nbuckets, Bool forceSmaller)
Set the cache size for accessing the hypercube containing the given row.
virtual Bool canChangeShape() const
Can the tiled storage manager handle changing array shapes? The default is no (but TiledCellStMan can...
static IPosition makeTileShape(const IPosition &hypercubeShape, const Vector< double > &weight, const Vector< double > &tolerance, uInt maxNrPixelsPerTile=32768)
void checkValues(const PtrBlock< TSMColumn * > &colSet, const Record &values) const
Check if values are given in the record for all columns in the block.
void headerFileGet(AipsIO &headerFile, uInt tabNrrow, Bool firstTime, Int extraNdim)
Read the data from the header file.
virtual Bool canAccessColumn(Bool &reask) const
Can the tiled storage manager access an entire column.
IPosition fixedCellShape_p
The fixed cell shape.
TSMCube * makeTSMCube(TSMFile *file, const IPosition &cubeShape, const IPosition &tileShape, const Record &values, Int64 fileOffset=-1)
Make the correct TSMCube type (depending on tsmOption()).
const TSMCube * getTSMCube(uInt hypercube) const
Get the given hypercube.
uInt calcCacheSize(uInt rownr, const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath) const
Calculate the cache size (in buckets) for accessing the hypercube containing the given row.
DataManagerColumn * makeScalarColumn(const String &name, int dataType, const String &dataTypeID)
Create a column in the storage manager on behalf of a table column.
AipsIO * headerFileOpen()
Open the TSM header file.
virtual IPosition defaultTileShape() const
Get the default tile shape.
virtual TSMCube * getHypercube(uInt rownr)=0
TableExprNode shape(const TableExprNode &array)
Function operating on any scalar or array resulting in a Double array containing the shape.
virtual void setShape(uInt rownr, TSMCube *hypercube, const IPosition &shape, const IPosition &tileShape)
Set the shape and tile shape of a hypercube.
uInt nrow() const
Get the nr of rows in this storage manager.
virtual String dataManagerName() const
Get the name given to the storage manager.
virtual Record dataManagerSpec() const
Return a record containing data manager specifications.
TSMCube * makeHypercube(const IPosition &cubeShape, const IPosition &tileShape, const Record &values)
Make a new TSMCube object.
void readTile(char *local, const Block< uInt > &localOffset, const char *external, const Block< uInt > &externalOffset, uInt nrpixels)
Read a tile and convert the data to local format.
uInt addedNrrow(const IPosition &shape, uInt incrInLastDim) const
Determine how many rows need to be added for an extension (in the last dimension) of a hypercube with...
PtrBlock< TSMDataColumn * > dataCols_p
The assembly of all data columns.
TiledStMan(const TiledStMan &)
Forbid copy constructor.
this file contains all the compiler specific defines
Bool flushCaches(Bool fsync)
Flush the caches of all hypercubes.
void setup(Int extraNdim=-1)
Set up the TiledStMan variables from the table description.
uInt nrrow_p
The number of rows in the columns.
void setCacheSize(uInt rownr, const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath, Bool forceSmaller)
Set the cache size using the calcCacheSize function mentioned above.
void showCacheStatistics(ostream &os) const
Show the statistics of all caches used.
void createFile(uInt index)
Create a TSMFile object and store its pointer at the given index in the block.
virtual const TableDesc & getDesc() const
Get the table description needed for the hypercolumn description.
virtual void readHeader(uInt nrrow, Bool firstTime)=0
Let a derived class read the header info.
virtual void reopenRW()
Reopen all files used in this storage manager for read/write access.
void setDataChanged()
Set the flag to "data has changed since last flush".
void setDataManagerName(const String &newHypercolumnName)
virtual void setMaximumCacheSize(uInt nMiB)
Set the maximum cache size (in MiB) in a non-persistent way.
Bool userSetCache(uInt rownr) const
Determine if the user set the cache size (using setCacheSize).
long long Int64
Define the extra non-standard types used by Casacore (like proposed uSize, Size)
TSMFile * getFile(uInt sequenceNumber)
Get the TSMFile object with the given sequence number.
Bool canAddRow() const
Does the storage manager allow to add rows? (yes)
uInt bucketSize(uInt rownr) const
Get the bucket size (in bytes) of the hypercube in the given row.
virtual void deleteManager()
The data manager will be deleted (because all its columns are requested to be deleted).
void setHypercubeCacheSize(uInt hypercube, uInt nbuckets, Bool forceSmaller)
Sets the cache size using the hypercube instead of the row number.
static IPosition makeTileShape(const IPosition &hypercubeShape, Double tolerance=0.5, uInt maxNrPixelsPerTile=32768)
Derive the tile shape from the hypercube shape for the given number of pixels per tile.
void emptyCaches()
Empty the caches used by the hypercubes in this storage manager.
const IPosition & tileShape(uInt rownr) const
Get the tile shape of the data in the given row.
String: the storage and methods of handling collections of characters.
PtrBlock< TSMFile * > fileSet_p
The assembly of all TSMFile objects.
AipsIO * headerFileCreate()
Create the TSM header file.
bool Bool
Define the standard types used by Casacore.
virtual Record getProperties() const
Get data manager properties that can be modified.
TiledStMan & operator=(const TiledStMan &)
Forbid assignment.
virtual void setupCheck(const TableDesc &tableDesc, const Vector< String > &dataNames) const
Function setup calls this function to allow the derived class to check specific information.
const TSMCube * getHypercube(uInt rownr) const
Get the hypercube in which the given row is stored.
DataManagerColumn * makeIndArrColumn(const String &name, int dataType, const String &dataTypeID)
Create an indirect array column.
void checkCoordinatesShapes(const TSMCube *hypercube, const IPosition &cubeShape) const
Check if the cube shape matches that of defined coordinates.
Int getCubeIndex(const Record &idValues) const
Get the index of the hypercube with the given id-values.
String hypercolumnName_p
The name of the hypercolumn.
void headerFilePut(AipsIO &headerFile, uInt nrCube)
Write the data into the header file.
void checkShapeColumn(const IPosition &shape) const
Check if the shapes of FixedShape data and coordinate columns match.
virtual void resync(uInt nrrow)
Resync the storage manager with the new file contents.
const TSMDataColumn * getDataColumn(uInt colnr) const
Get pointer to data column object.
TiledStMan(const String &hypercolumnName, uInt maximumCacheSizeMiB)
Create a TiledStMan storage manager.
virtual Bool hasMultiFileSupport() const
The data manager supports use of MultiFile.
int coordinateDataType(const String &columnName) const
Get the data type of the coordinate column with the given name.
void checkCubeShape(const TSMCube *hypercube, const IPosition &cubeShape) const
Check the shape to be set for a hypercube.
uInt maxCacheSize_p
The actual maximum cache size for a hypercube (in MiB).
void setPersMaxCacheSize(uInt nMiB)
Set the persistent maximum cache size (in MiB).
uInt getLengthOffset(uInt nrPixels, Block< uInt > &dataOffset, Block< uInt > &localOffset, uInt &localTileLength) const
Get the length of the data for the given number of pixels.