Base class for Tiled Storage Manager classes. More...
#include <TiledStMan.h>
Public Member Functions | |
TiledStMan () | |
Create a TiledStMan. | |
TiledStMan (const String &hypercolumnName, uInt maximumCacheSize) | |
Create a TiledStMan storage manager. | |
virtual | ~TiledStMan () |
virtual String | dataManagerName () const |
Get the name given to the storage manager. | |
void | setDataManagerName (const String &newHypercolumnName) |
virtual Record | dataManagerSpec () const |
Return a record containing data manager specifications. | |
virtual Record | getProperties () const |
Get data manager properties that can be modified. | |
virtual void | setProperties (const Record &spec) |
Modify data manager properties. | |
void | setDataChanged () |
Set the flag to "data has changed since last flush". | |
virtual void | setMaximumCacheSize (uInt nbytes) |
Set the maximum cache size (in bytes) in a non-persistent way. | |
uInt | maximumCacheSize () const |
Get the current maximum cache size (in bytes). | |
uInt | cacheSize (uInt rownr) const |
Get the current cache size (in buckets) for the hypercube in the given row. | |
const IPosition & | hypercubeShape (uInt rownr) const |
Get the hypercube shape of the data in the given row. | |
const IPosition & | tileShape (uInt rownr) const |
Get the tile shape of the data in the given row. | |
uInt | bucketSize (uInt rownr) const |
Get the bucket size (in bytes) of the hypercube in the given row. | |
virtual Bool | canChangeShape () const |
Can the tiled storage manager handle changing array shapes? The default is no (but TiledCellStMan can). | |
virtual Bool | canAccessColumn (Bool &reask) const |
Can the tiled storage manager access an entire column. | |
virtual Bool | hasMultiFileSupport () const |
The data manager supports use of MultiFile. | |
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. | |
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 | setCacheSize (uInt rownr, uInt nbuckets, Bool forceSmaller) |
Set the cache size for accessing the hypercube containing the given row. | |
void | setHypercubeCacheSize (uInt hypercube, uInt nbuckets, Bool forceSmaller) |
Sets the cache size using the hypercube instead of the row number. | |
Bool | userSetCache (uInt rownr) const |
Determine if the user set the cache size (using setCacheSize). | |
void | emptyCaches () |
Empty the caches used by the hypercubes in this storage manager. | |
void | showCacheStatistics (ostream &os) const |
Show the statistics of all caches used. | |
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. | |
uInt | nrCoordVector () const |
Get the number of coordinate vectors. | |
uInt | nrow () const |
Get the nr of rows in this storage manager. | |
Bool | canAddRow () const |
Does the storage manager allow to add rows? (yes). | |
virtual IPosition | defaultTileShape () const |
Get the default tile shape. | |
uInt | nhypercubes () const |
Return the number of hypercubes. | |
virtual TSMCube * | singleHypercube () |
Test if only one hypercube is used by this storage manager. | |
const TSMCube * | getTSMCube (uInt hypercube) const |
Get the given hypercube. | |
TSMCube * | getTSMCube (uInt hypercube) |
const TSMCube * | getHypercube (uInt rownr) const |
Get the hypercube in which the given row is stored. | |
virtual TSMCube * | getHypercube (uInt rownr)=0 |
virtual TSMCube * | getHypercube (uInt rownr, IPosition &position)=0 |
Get the hypercube in which the given row is stored. | |
TSMCube * | makeTSMCube (TSMFile *file, const IPosition &cubeShape, const IPosition &tileShape, const Record &values, Int64 fileOffset=-1) |
Make the correct TSMCube type (depending on tsmOption()). | |
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. | |
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. | |
TSMFile * | getFile (uInt sequenceNumber) |
Get the TSMFile object with the given sequence number. | |
virtual void | open (uInt nrrow, AipsIO &) |
Open the storage manager for an existing table. | |
virtual void | resync (uInt nrrow) |
Resync the storage manager with the new file contents. | |
virtual void | reopenRW () |
Reopen all files used in this storage manager for read/write access. | |
virtual void | deleteManager () |
The data manager will be deleted (because all its columns are requested to be deleted). | |
DataManagerColumn * | makeScalarColumn (const String &name, int dataType, const String &dataTypeID) |
Create a column in the storage manager on behalf of a table column. | |
DataManagerColumn * | makeDirArrColumn (const String &name, int dataType, const String &dataTypeID) |
Create a direct array column. | |
DataManagerColumn * | makeIndArrColumn (const String &name, int dataType, const String &dataTypeID) |
Create an indirect array column. | |
Bool | canReallocateColumns () const |
The TiledStMan wants to do reallocateColumn. | |
DataManagerColumn * | reallocateColumn (DataManagerColumn *column) |
Reallocate the column object if it is part of this data manager. | |
virtual void | setShape (uInt rownr, TSMCube *hypercube, const IPosition &shape, const IPosition &tileShape) |
Set the shape and tile shape of a hypercube. | |
void | checkCubeShape (const TSMCube *hypercube, const IPosition &cubeShape) const |
Check the shape to be set for a hypercube. | |
int | coordinateDataType (const String &columnName) const |
Get the data type of the coordinate column with the given name. | |
void | initCoordinates (TSMCube *hypercube) |
Initialize the new coordinates for the given cube. | |
const TSMDataColumn * | getDataColumn (uInt colnr) const |
Get pointer to data column object. | |
Static Public Member Functions | |
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. | |
static IPosition | makeTileShape (const IPosition &hypercubeShape, const Vector< double > &weight, const Vector< double > &tolerance, uInt maxNrPixelsPerTile=32768) |
Protected Member Functions | |
void | setPersMaxCacheSize (uInt nbytes) |
Set the persistent maximum cache size. | |
uInt | getBindings (const Vector< String > &columnNames, PtrBlock< TSMColumn * > &colSet, Bool mustExist) const |
Get the bindings of the columns with the given names. | |
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. | |
virtual const TableDesc & | getDesc () const |
Get the table description needed for the hypercolumn description. | |
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 | checkCoordinates (const PtrBlock< TSMColumn * > &coordColSet, const IPosition &cubeShape, const Record &values) const |
Check if the coordinate values are correct. | |
void | checkShapeColumn (const IPosition &shape) const |
Check if the shapes of FixedShape data and coordinate columns match. | |
void | checkCoordinatesShapes (const TSMCube *hypercube, const IPosition &cubeShape) const |
Check if the cube shape matches that of defined coordinates. | |
void | checkAddHypercube (const IPosition &cubeShape, const Record &values) const |
Check if the hypercube to be added is correctly defined. | |
TSMCube * | makeHypercube (const IPosition &cubeShape, const IPosition &tileShape, const Record &values) |
Make a new TSMCube object. | |
Int | getCubeIndex (const Record &idValues) const |
Get the index of the hypercube with the given id-values. | |
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 the given shape. | |
Bool | flushCaches (Bool fsync) |
Flush the caches of all hypercubes. | |
virtual void | readHeader (uInt nrrow, Bool firstTime)=0 |
Let a derived class read the header info. | |
AipsIO * | headerFileCreate () |
Create the TSM header file. | |
AipsIO * | headerFileOpen () |
Open the TSM header file. | |
void | headerFilePut (AipsIO &headerFile, uInt nrCube) |
Write the data into the header file. | |
void | headerFileGet (AipsIO &headerFile, uInt tabNrrow, Bool firstTime, Int extraNdim) |
Read the data from the header file. | |
void | headerFileClose (AipsIO *headerFile) |
Close the header file. | |
void | setup (Int extraNdim=-1) |
Set up the TiledStMan variables from the table description. | |
void | createFile (uInt index) |
Create a TSMFile object and store its pointer at the given index in the block. | |
int | arrayDataType (int dataType) const |
Convert the scalar data type to an array data type. | |
Protected Attributes | |
String | hypercolumnName_p |
The name of the hypercolumn. | |
uInt | nrrow_p |
The number of rows in the columns. | |
PtrBlock< TSMColumn * > | colSet_p |
The assembly of all columns. | |
PtrBlock< TSMDataColumn * > | dataCols_p |
The assembly of all data columns. | |
PtrBlock< TSMColumn * > | dataColSet_p |
PtrBlock< TSMColumn * > | idColSet_p |
The assembly of all id columns. | |
PtrBlock< TSMColumn * > | coordColSet_p |
The assembly of all coordinate columns. | |
PtrBlock< TSMFile * > | fileSet_p |
The assembly of all TSMFile objects. | |
PtrBlock< TSMCube * > | cubeSet_p |
The assembly of all TSMCube objects. | |
uInt | persMaxCacheSize_p |
The persistent maximum cache size for a hypercube. | |
uInt | maxCacheSize_p |
The actual maximum cache size for a hypercube. | |
uInt | nrdim_p |
The dimensionality of the hypercolumn. | |
uInt | nrCoordVector_p |
The number of vector coordinates. | |
IPosition | fixedCellShape_p |
The fixed cell shape. | |
Bool | dataChanged_p |
Has any data changed since the last flush? | |
Private Member Functions | |
TiledStMan (const TiledStMan &) | |
Forbid copy constructor. | |
TiledStMan & | operator= (const TiledStMan &) |
Forbid assignment. |
Base class for Tiled Storage Manager classes.
Public interface
TiledStMan is the base class for Tiled Storage Managers. A tiled storage manager is capable of storing a hypercolumn (as defined by TableDesc::defineHypercolumn ) in one or more hypercubes.
It is not necessary to define a hypercolumn. If not defined, it is assumed that all columns bound to this storage manager are data columns. At least one of the columns must have a fixed dimensionality and is used to determine the hypercube dimnensionality.
The general concept of these storage managers is explained in the Tables module description .
TiledStMan contains all common functions for the different tiled storage managers. In particular, it contains functions to check if the definitions of the shapes of hypercubes, coordinates, and data cells are consistent. It also contains various data members and functions to make them persistent by writing them into an AipsIO stream.
This base class contains the common functionality of all tiled storage managers. The base class is still abstract. Only concrete tiled storage managers derived from it can be instantiated.
Tiled storage managers make access to array data possible with more or less the same efficiency for access along different axes.
Definition at line 107 of file TiledStMan.h.
casacore::TiledStMan::TiledStMan | ( | ) |
Create a TiledStMan.
Create a TiledStMan storage manager.
The given maximum cache size is persistent, thus will be reused when the table is read back. Note that the class ROTiledStManAccessor allows one to overwrite the maximum cache size temporarily. Its description contains a discussion about the effects of setting a maximum cache.
virtual casacore::TiledStMan::~TiledStMan | ( | ) | [virtual] |
casacore::TiledStMan::TiledStMan | ( | const TiledStMan & | ) | [private] |
Forbid copy constructor.
uInt casacore::TiledStMan::addedNrrow | ( | const IPosition & | shape, | |
uInt | incrInLastDim | |||
) | const [protected] |
Determine how many rows need to be added for an extension (in the last dimension) of a hypercube with the given shape.
int casacore::TiledStMan::arrayDataType | ( | int | dataType | ) | const [protected] |
Convert the scalar data type to an array data type.
This function is temporary and can disappear when the ColumnDesc classes use type TpArray*.
Get the bucket size (in bytes) of the hypercube in the given row.
Get the current cache size (in buckets) for the hypercube in the given row.
uInt casacore::TiledStMan::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.
It takes the maximum cache size into account (allowing an overdraft of 10%). It uses the given axisPath (i.e. traversal order) to determine the optimum size. A window can be specified to indicate that only the given subset of the hypercube will be accessed.
The length of the slice and window arguments and axisPath
must be less or equal to the dimensionality of the hypercube. The non-specified windowStart
parts default to 0. The non-specified windowLength
parts default to the hypercube shape. The non-specified sliceShape
parts default to 1.
Axispath = [2,0,1] indicates that the z-axis changes most rapidly, thereafter x and y. An axis can occur only once in the axisPath. The non-specified axisPath
parts get the natural order. E.g. in the previous example axisPath=[2] defines the same path.
When forceSmaller is False, the cache is not resized when the new size is smaller.
A flag is set indicating that the TSMDataColumn access functions do not need to size the cache.
Can the tiled storage manager access an entire column.
TiledColumnStMan can always do that. The others might be able to do it (for this time). The default implementation returns True if there is only 1 hypercube. reask is set to True (because next time things might be different).
Reimplemented in casacore::TiledColumnStMan, and casacore::TiledShapeStMan.
Bool casacore::TiledStMan::canAddRow | ( | ) | const [virtual] |
Does the storage manager allow to add rows? (yes).
Reimplemented from casacore::DataManager.
virtual Bool casacore::TiledStMan::canChangeShape | ( | ) | const [virtual] |
Can the tiled storage manager handle changing array shapes? The default is no (but TiledCellStMan can).
Reimplemented in casacore::TiledCellStMan.
Bool casacore::TiledStMan::canReallocateColumns | ( | ) | const [virtual] |
The TiledStMan wants to do reallocateColumn.
Reimplemented from casacore::DataManager.
void casacore::TiledStMan::checkAddHypercube | ( | const IPosition & | cubeShape, | |
const Record & | values | |||
) | const [protected] |
Check if the hypercube to be added is correctly defined.
void casacore::TiledStMan::checkCoordinates | ( | const PtrBlock< TSMColumn * > & | coordColSet, | |
const IPosition & | cubeShape, | |||
const Record & | values | |||
) | const [protected] |
Check if the coordinate values are correct.
This calls checkValues and checks if their shapes match the hypercube shape. An exception is thrown if invalid.
void casacore::TiledStMan::checkCoordinatesShapes | ( | const TSMCube * | hypercube, | |
const IPosition & | cubeShape | |||
) | const [protected] |
Check if the cube shape matches that of defined coordinates.
void casacore::TiledStMan::checkCubeShape | ( | const TSMCube * | hypercube, | |
const IPosition & | cubeShape | |||
) | const |
Check the shape to be set for a hypercube.
It checks if it matches predefined (fixed shape) columns and the shape of already defined coordinate columns.
void casacore::TiledStMan::checkShapeColumn | ( | const IPosition & | shape | ) | const [protected] |
Check if the shapes of FixedShape data and coordinate columns match.
An exception is thrown if not.
void casacore::TiledStMan::checkValues | ( | const PtrBlock< TSMColumn * > & | colSet, | |
const Record & | values | |||
) | const [protected] |
Check if values are given in the record for all columns in the block.
Also check if the data types are correct. An exception is thrown if something is incorrect.
int casacore::TiledStMan::coordinateDataType | ( | const String & | columnName | ) | const |
Get the data type of the coordinate column with the given name.
An exception is thrown when the column is unknown.
void casacore::TiledStMan::createFile | ( | uInt | index | ) | [protected] |
Create a TSMFile object and store its pointer at the given index in the block.
virtual String casacore::TiledStMan::dataManagerName | ( | ) | const [virtual] |
Get the name given to the storage manager.
This is the name of the hypercolumn.
Reimplemented from casacore::DataManager.
virtual Record casacore::TiledStMan::dataManagerSpec | ( | ) | const [virtual] |
Return a record containing data manager specifications.
Reimplemented from casacore::DataManager.
Reimplemented in casacore::TiledShapeStMan.
virtual IPosition casacore::TiledStMan::defaultTileShape | ( | ) | const [virtual] |
Get the default tile shape.
By default it returns a zero-length IPosition.
Reimplemented in casacore::TiledCellStMan, casacore::TiledColumnStMan, and casacore::TiledShapeStMan.
virtual void casacore::TiledStMan::deleteManager | ( | ) | [virtual] |
The data manager will be deleted (because all its columns are requested to be deleted).
So clean up the things needed (e.g. delete files).
Implements casacore::DataManager.
void casacore::TiledStMan::emptyCaches | ( | ) |
Empty the caches used by the hypercubes in this storage manager.
It will flush the caches as needed and remove all buckets from them resulting in a possibly large drop in memory used. It also clears the userSetCache flag.
Flush the caches of all hypercubes.
If data have put and fsync is set, fsync all files.
uInt casacore::TiledStMan::getBindings | ( | const Vector< String > & | columnNames, | |
PtrBlock< TSMColumn * > & | colSet, | |||
Bool | mustExist | |||
) | const [protected] |
Get the bindings of the columns with the given names.
If bound, the pointer to the TSMColumn object is stored in the block. If mustExist is True, an exception is thrown if the column is not bound. It returns the number of bound columns.
Get the index of the hypercube with the given id-values.
If not found, -1 is returned.
const TSMDataColumn* casacore::TiledStMan::getDataColumn | ( | uInt | colnr | ) | const [inline] |
Get pointer to data column object.
Definition at line 379 of file TiledStMan.h.
References dataCols_p.
virtual const TableDesc& casacore::TiledStMan::getDesc | ( | ) | const [protected, virtual] |
Get the table description needed for the hypercolumn description.
Reimplemented in casacore::TiledFileHelper.
Get the TSMFile object with the given sequence number.
virtual TSMCube* casacore::TiledStMan::getHypercube | ( | uInt | rownr, | |
IPosition & | position | |||
) | [pure virtual] |
Get the hypercube in which the given row is stored.
It also returns the position of the row in that hypercube.
Implemented in casacore::TiledCellStMan, casacore::TiledColumnStMan, casacore::TiledDataStMan, casacore::TiledFileHelper, and casacore::TiledShapeStMan.
Get the hypercube in which the given row is stored.
Definition at line 551 of file TiledStMan.h.
uInt casacore::TiledStMan::getLengthOffset | ( | uInt | nrPixels, | |
Block< uInt > & | dataOffset, | |||
Block< uInt > & | localOffset, | |||
uInt & | localTileLength | |||
) | const |
Get the length of the data for the given number of pixels.
This can be used to calculate the length of a tile.
virtual Record casacore::TiledStMan::getProperties | ( | ) | const [virtual] |
Get data manager properties that can be modified.
It is only ActualCacheSize (the actual cache size in buckets). It is a subset of the data manager specification.
Reimplemented from casacore::DataManager.
Get the given hypercube.
Definition at line 548 of file TiledStMan.h.
virtual Bool casacore::TiledStMan::hasMultiFileSupport | ( | ) | const [virtual] |
The data manager supports use of MultiFile.
Reimplemented from casacore::DataManager.
void casacore::TiledStMan::headerFileClose | ( | AipsIO * | headerFile | ) | [protected] |
AipsIO* casacore::TiledStMan::headerFileCreate | ( | ) | [protected] |
AipsIO* casacore::TiledStMan::headerFileOpen | ( | ) | [protected] |
Get the hypercube shape of the data in the given row.
void casacore::TiledStMan::initCoordinates | ( | TSMCube * | hypercube | ) |
Initialize the new coordinates for the given cube.
DataManagerColumn* casacore::TiledStMan::makeDirArrColumn | ( | const String & | name, | |
int | dataType, | |||
const String & | dataTypeID | |||
) | [virtual] |
Create a direct array column.
Implements casacore::DataManager.
TSMCube* casacore::TiledStMan::makeHypercube | ( | const IPosition & | cubeShape, | |
const IPosition & | tileShape, | |||
const Record & | values | |||
) | [protected] |
Make a new TSMCube object.
DataManagerColumn* casacore::TiledStMan::makeIndArrColumn | ( | const String & | name, | |
int | dataType, | |||
const String & | dataTypeID | |||
) | [virtual] |
Create an indirect array column.
Implements casacore::DataManager.
DataManagerColumn* casacore::TiledStMan::makeScalarColumn | ( | const String & | name, | |
int | dataType, | |||
const String & | dataTypeID | |||
) | [virtual] |
Create a column in the storage manager on behalf of a table column.
Create a scalar column.
Implements casacore::DataManager.
static IPosition casacore::TiledStMan::makeTileShape | ( | const IPosition & | hypercubeShape, | |
const Vector< double > & | weight, | |||
const Vector< double > & | tolerance, | |||
uInt | maxNrPixelsPerTile = 32768 | |||
) | [static] |
static IPosition casacore::TiledStMan::makeTileShape | ( | const IPosition & | hypercubeShape, | |
Double | tolerance = 0.5 , |
|||
uInt | maxNrPixelsPerTile = 32768 | |||
) | [static] |
Derive the tile shape from the hypercube shape for the given number of pixels per tile.
It is tried to get the same number of tiles for each dimension. When a weight vector is given, the number of tiles for a dimension is proportional to the weight.
After the initial guess it tries to optimize it by trying to waste as little space as possible, while trying to keep as close to the initial guess. The given tolerance (possibly per axis) gives the minimum and maximum possible length of a tile axis (minimum = initial_guess*tolerance; maximum = initial_guess/tolerance). The heuristic is such that a tile axis length dividing the cube length exactly is always favoured. The test program tTiledStMan
can be used to see how the algorithm works out for a given tile size and cube shape.
TSMCube* casacore::TiledStMan::makeTSMCube | ( | TSMFile * | file, | |
const IPosition & | cubeShape, | |||
const IPosition & | tileShape, | |||
const Record & | values, | |||
Int64 | fileOffset = -1 | |||
) |
Make the correct TSMCube type (depending on tsmOption()).
uInt casacore::TiledStMan::maximumCacheSize | ( | ) | const [inline] |
Get the current maximum cache size (in bytes).
Definition at line 533 of file TiledStMan.h.
References maxCacheSize_p.
uInt casacore::TiledStMan::nhypercubes | ( | ) | const [inline] |
Return the number of hypercubes.
Definition at line 542 of file TiledStMan.h.
References cubeSet_p, and casacore::PtrBlock< T >::nelements().
uInt casacore::TiledStMan::nrCoordVector | ( | ) | const [inline] |
Get the number of coordinate vectors.
Definition at line 536 of file TiledStMan.h.
References nrCoordVector_p.
uInt casacore::TiledStMan::nrow | ( | ) | const [inline] |
Get the nr of rows in this storage manager.
Definition at line 539 of file TiledStMan.h.
References nrrow_p.
Open the storage manager for an existing table.
Implements casacore::DataManager.
TiledStMan& casacore::TiledStMan::operator= | ( | const TiledStMan & | ) | [private] |
Forbid assignment.
Reimplemented from casacore::DataManager.
Reimplemented in casacore::TiledCellStMan, casacore::TiledColumnStMan, casacore::TiledDataStMan, casacore::TiledFileHelper, and casacore::TiledShapeStMan.
virtual void casacore::TiledStMan::readHeader | ( | uInt | nrrow, | |
Bool | firstTime | |||
) | [protected, pure virtual] |
Let a derived class read the header info.
This is used by the open and resync function.
Implemented in casacore::TiledCellStMan, casacore::TiledColumnStMan, casacore::TiledDataStMan, casacore::TiledFileHelper, and casacore::TiledShapeStMan.
void casacore::TiledStMan::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.
DataManagerColumn* casacore::TiledStMan::reallocateColumn | ( | DataManagerColumn * | column | ) | [virtual] |
Reallocate the column object if it is part of this data manager.
It returns a pointer to the new column object. It is used to remove the indirection of the TSMColumn objects resulting in only one iso. two virtual column calls to get the data.
Reimplemented from casacore::DataManager.
virtual void casacore::TiledStMan::reopenRW | ( | ) | [virtual] |
Reopen all files used in this storage manager for read/write access.
Reimplemented from casacore::DataManager.
virtual void casacore::TiledStMan::resync | ( | uInt | nrrow | ) | [virtual] |
Resync the storage manager with the new file contents.
Implements casacore::DataManager.
Set the cache size for accessing the hypercube containing the given row.
When the give cache size exceeds the maximum cache size with more than 10%, the maximum cache size is used instead.
When forceSmaller is False, the cache is not resized when the new size is smaller.
A flag is set indicating that the TSMDataColumn access functions do not need to size the cache.
void casacore::TiledStMan::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 casacore::TiledStMan::setDataChanged | ( | ) | [inline] |
Set the flag to "data has changed since last flush".
Definition at line 545 of file TiledStMan.h.
References dataChanged_p, and casacore::True.
void casacore::TiledStMan::setDataManagerName | ( | const String & | newHypercolumnName | ) |
void casacore::TiledStMan::setHypercubeCacheSize | ( | uInt | hypercube, | |
uInt | nbuckets, | |||
Bool | forceSmaller | |||
) |
Sets the cache size using the hypercube instead of the row number.
Useful for iterating over all hypercubes.
virtual void casacore::TiledStMan::setMaximumCacheSize | ( | uInt | nbytes | ) | [virtual] |
Set the maximum cache size (in bytes) in a non-persistent way.
Reimplemented from casacore::DataManager.
void casacore::TiledStMan::setPersMaxCacheSize | ( | uInt | nbytes | ) | [inline, protected] |
Set the persistent maximum cache size.
Definition at line 554 of file TiledStMan.h.
References maxCacheSize_p, and persMaxCacheSize_p.
virtual void casacore::TiledStMan::setProperties | ( | const Record & | spec | ) | [virtual] |
Modify data manager properties.
Only ActualCacheSize can be used. It is similar to function setCacheSize with canExceedNrBuckets=False
.
Reimplemented from casacore::DataManager.
virtual void casacore::TiledStMan::setShape | ( | uInt | rownr, | |
TSMCube * | hypercube, | |||
const IPosition & | shape, | |||
const IPosition & | tileShape | |||
) | [virtual] |
Set the shape and tile shape of a hypercube.
By default it throws an "impossible" exception.
Reimplemented in casacore::TiledCellStMan, and casacore::TiledShapeStMan.
void casacore::TiledStMan::setup | ( | Int | extraNdim = -1 |
) | [protected] |
Set up the TiledStMan variables from the table description.
The argument specifies the number of extra dimensions for the hypercube compared to the data array (usually 0 or 1). It is only used if no hypercolumn definition exists. -1 means that the hypercolumn definition has to be present.
virtual void casacore::TiledStMan::setupCheck | ( | const TableDesc & | tableDesc, | |
const Vector< String > & | dataNames | |||
) | const [protected, virtual] |
Function setup calls this function to allow the derived class to check specific information.
In case of errors, an exception should be thrown. By default it does nothing.
Reimplemented in casacore::TiledCellStMan, casacore::TiledColumnStMan, and casacore::TiledShapeStMan.
void casacore::TiledStMan::showCacheStatistics | ( | ostream & | os | ) | const |
Show the statistics of all caches used.
virtual TSMCube* casacore::TiledStMan::singleHypercube | ( | ) | [virtual] |
Test if only one hypercube is used by this storage manager.
If not, throw an exception. Otherwise return the hypercube.
Reimplemented in casacore::TiledShapeStMan.
Get the tile shape of the data in the given row.
Determine if the user set the cache size (using setCacheSize).
void casacore::TiledStMan::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.
PtrBlock<TSMColumn*> casacore::TiledStMan::colSet_p [protected] |
The assembly of all columns.
Definition at line 497 of file TiledStMan.h.
PtrBlock<TSMColumn*> casacore::TiledStMan::coordColSet_p [protected] |
The assembly of all coordinate columns.
Definition at line 504 of file TiledStMan.h.
PtrBlock<TSMCube*> casacore::TiledStMan::cubeSet_p [protected] |
The assembly of all TSMCube objects.
Definition at line 510 of file TiledStMan.h.
Referenced by nhypercubes().
Bool casacore::TiledStMan::dataChanged_p [protected] |
Has any data changed since the last flush?
Definition at line 522 of file TiledStMan.h.
Referenced by setDataChanged().
PtrBlock<TSMDataColumn*> casacore::TiledStMan::dataCols_p [protected] |
The assembly of all data columns.
Definition at line 499 of file TiledStMan.h.
Referenced by getDataColumn().
PtrBlock<TSMColumn*> casacore::TiledStMan::dataColSet_p [protected] |
Definition at line 500 of file TiledStMan.h.
PtrBlock<TSMFile*> casacore::TiledStMan::fileSet_p [protected] |
The assembly of all TSMFile objects.
The first file is for all non-extensible cubes, while the others are for one file per extensible cube.
Definition at line 508 of file TiledStMan.h.
Referenced by casacore::TiledFileHelper::file().
IPosition casacore::TiledStMan::fixedCellShape_p [protected] |
The fixed cell shape.
Definition at line 520 of file TiledStMan.h.
String casacore::TiledStMan::hypercolumnName_p [protected] |
The name of the hypercolumn.
Definition at line 493 of file TiledStMan.h.
PtrBlock<TSMColumn*> casacore::TiledStMan::idColSet_p [protected] |
The assembly of all id columns.
Definition at line 502 of file TiledStMan.h.
uInt casacore::TiledStMan::maxCacheSize_p [protected] |
The actual maximum cache size for a hypercube.
Definition at line 514 of file TiledStMan.h.
Referenced by maximumCacheSize(), and setPersMaxCacheSize().
uInt casacore::TiledStMan::nrCoordVector_p [protected] |
The number of vector coordinates.
Definition at line 518 of file TiledStMan.h.
Referenced by nrCoordVector().
uInt casacore::TiledStMan::nrdim_p [protected] |
The dimensionality of the hypercolumn.
Definition at line 516 of file TiledStMan.h.
uInt casacore::TiledStMan::nrrow_p [protected] |
The number of rows in the columns.
Definition at line 495 of file TiledStMan.h.
Referenced by nrow().
uInt casacore::TiledStMan::persMaxCacheSize_p [protected] |
The persistent maximum cache size for a hypercube.
Definition at line 512 of file TiledStMan.h.
Referenced by setPersMaxCacheSize().