casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
casacore::TiledStMan Class Referenceabstract

Base class for Tiled Storage Manager classes. More...

#include <TiledStMan.h>

Inheritance diagram for casacore::TiledStMan:
casacore::DataManager casacore::TiledCellStMan casacore::TiledColumnStMan casacore::TiledDataStMan casacore::TiledFileHelper casacore::TiledShapeStMan

Public Member Functions

 TiledStMan ()
 Create a TiledStMan. More...
 
 TiledStMan (const String &hypercolumnName, uInt maximumCacheSizeMiB)
 Create a TiledStMan storage manager. More...
 
virtual ~TiledStMan ()
 
virtual String dataManagerName () const
 Get the name given to the storage manager. More...
 
void setDataManagerName (const String &newHypercolumnName)
 
virtual Record dataManagerSpec () const
 Return a record containing data manager specifications. More...
 
virtual Record getProperties () const
 Get data manager properties that can be modified. More...
 
virtual void setProperties (const Record &spec)
 Modify data manager properties. More...
 
void setDataChanged ()
 Set the flag to "data has changed since last flush". More...
 
virtual void setMaximumCacheSize (uInt nMiB)
 Set the maximum cache size (in MiB) in a non-persistent way. More...
 
uInt maximumCacheSize () const
 Get the current maximum cache size (in MiB (MibiByte)). More...
 
uInt cacheSize (uInt rownr) const
 Get the current cache size (in buckets) for the hypercube in the given row. More...
 
const IPositionhypercubeShape (uInt rownr) const
 Get the hypercube shape of the data in the given row. More...
 
const IPositiontileShape (uInt rownr) const
 Get the tile shape of the data in the given row. More...
 
uInt bucketSize (uInt rownr) const
 Get the bucket size (in bytes) of the hypercube in the given row. More...
 
virtual Bool canChangeShape () const
 Can the tiled storage manager handle changing array shapes? The default is no (but TiledCellStMan can). More...
 
virtual Bool canAccessColumn (Bool &reask) const
 Can the tiled storage manager access an entire column. More...
 
virtual Bool hasMultiFileSupport () const
 The data manager supports use of MultiFile. More...
 
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. More...
 
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. More...
 
void setCacheSize (uInt rownr, uInt nbuckets, Bool forceSmaller)
 Set the cache size for accessing the hypercube containing the given row. More...
 
void setHypercubeCacheSize (uInt hypercube, uInt nbuckets, Bool forceSmaller)
 Sets the cache size using the hypercube instead of the row number. More...
 
Bool userSetCache (uInt rownr) const
 Determine if the user set the cache size (using setCacheSize). More...
 
void emptyCaches ()
 Empty the caches used by the hypercubes in this storage manager. More...
 
void showCacheStatistics (ostream &os) const
 Show the statistics of all caches used. More...
 
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. More...
 
uInt nrCoordVector () const
 Get the number of coordinate vectors. More...
 
uInt nrow () const
 Get the nr of rows in this storage manager. More...
 
Bool canAddRow () const
 Does the storage manager allow to add rows? (yes) More...
 
virtual IPosition defaultTileShape () const
 Get the default tile shape. More...
 
uInt nhypercubes () const
 Return the number of hypercubes. More...
 
virtual TSMCubesingleHypercube ()
 Test if only one hypercube is used by this storage manager. More...
 
const TSMCubegetTSMCube (uInt hypercube) const
 Get the given hypercube. More...
 
TSMCubegetTSMCube (uInt hypercube)
 
const TSMCubegetHypercube (uInt rownr) const
 Get the hypercube in which the given row is stored. More...
 
virtual TSMCubegetHypercube (uInt rownr)=0
 
virtual TSMCubegetHypercube (uInt rownr, IPosition &position)=0
 Get the hypercube in which the given row is stored. More...
 
TSMCubemakeTSMCube (TSMFile *file, const IPosition &cubeShape, const IPosition &tileShape, const Record &values, Int64 fileOffset=-1)
 Make the correct TSMCube type (depending on tsmOption()). More...
 
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. More...
 
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. More...
 
TSMFilegetFile (uInt sequenceNumber)
 Get the TSMFile object with the given sequence number. More...
 
virtual void open (uInt nrrow, AipsIO &)
 Open the storage manager for an existing table. More...
 
virtual void resync (uInt nrrow)
 Resync the storage manager with the new file contents. More...
 
virtual void reopenRW ()
 Reopen all files used in this storage manager for read/write access. More...
 
virtual void deleteManager ()
 The data manager will be deleted (because all its columns are requested to be deleted). More...
 
DataManagerColumnmakeScalarColumn (const String &name, int dataType, const String &dataTypeID)
 Create a column in the storage manager on behalf of a table column. More...
 
DataManagerColumnmakeDirArrColumn (const String &name, int dataType, const String &dataTypeID)
 Create a direct array column. More...
 
DataManagerColumnmakeIndArrColumn (const String &name, int dataType, const String &dataTypeID)
 Create an indirect array column. More...
 
Bool canReallocateColumns () const
 The TiledStMan wants to do reallocateColumn. More...
 
DataManagerColumnreallocateColumn (DataManagerColumn *column)
 Reallocate the column object if it is part of this data manager. More...
 
virtual void setShape (uInt rownr, TSMCube *hypercube, const IPosition &shape, const IPosition &tileShape)
 Set the shape and tile shape of a hypercube. More...
 
void checkCubeShape (const TSMCube *hypercube, const IPosition &cubeShape) const
 Check the shape to be set for a hypercube. More...
 
int coordinateDataType (const String &columnName) const
 Get the data type of the coordinate column with the given name. More...
 
void initCoordinates (TSMCube *hypercube)
 Initialize the new coordinates for the given cube. More...
 
const TSMDataColumngetDataColumn (uInt colnr) const
 Get pointer to data column object. More...
 
- Public Member Functions inherited from casacore::DataManager
 DataManager ()
 Default constructor. More...
 
virtual ~DataManager ()
 
virtual DataManagerclone () const =0
 Make a clone of the derived object. More...
 
virtual String dataManagerType () const =0
 Return the type name of the data manager (in fact its class name). More...
 
void dataManagerInfo (Record &info) const
 Add SEQNR and SPEC (the DataManagerSpec subrecord) to the info. More...
 
virtual Bool isStorageManager () const
 Is the data manager a storage manager? The default is yes. More...
 
uInt sequenceNr () const
 Get the (unique) sequence nr of this data manager. More...
 
uInt ncolumn () const
 Get the nr of columns in this data manager (can be zero). More...
 
Bool asBigEndian () const
 Have the data to be stored in big or little endian canonical format? More...
 
const TSMOptiontsmOption () const
 Get the TSM option. More...
 
MultiFileBasemultiFile ()
 Get the MultiFile pointer (can be 0). More...
 
String keywordName (const String &keyword) const
 Compose a keyword name from the given keyword appended with the sequence number (e.g. More...
 
String fileName () const
 Compose a unique filename from the table name and sequence number. More...
 
ByteIO::OpenOption fileOption () const
 Get the AipsIO option of the underlying file. More...
 
virtual Bool isRegular () const
 Is this a regular storage manager? It is regular if it allows addition of rows and writing data in them. More...
 
Tabletable () const
 Get the table this object is associated with. More...
 
virtual Bool canRemoveRow () const
 Does the data manager allow to delete rows? (default no) More...
 
virtual Bool canAddColumn () const
 Does the data manager allow to add columns? (default no) More...
 
virtual Bool canRemoveColumn () const
 Does the data manager allow to delete columns? (default no) More...
 
virtual Bool canRenameColumn () const
 Does the data manager allow to rename columns? (default yes) More...
 
virtual void showCacheStatistics (std::ostream &) const
 Show the data manager's IO statistics. More...
 
DataManagerColumncreateScalarColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create a column in the data manager on behalf of a table column. More...
 
DataManagerColumncreateDirArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create a direct array column. More...
 
DataManagerColumncreateIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create an indirect array column. More...
 
DataManagergetClone () const
 Has the object already been cloned? More...
 
void setClone (DataManager *clone) const
 Set the pointer to the clone. More...
 

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. More...
 
static IPosition makeTileShape (const IPosition &hypercubeShape, const Vector< double > &weight, const Vector< double > &tolerance, uInt maxNrPixelsPerTile=32768)
 
- Static Public Member Functions inherited from casacore::DataManager
static void registerCtor (const String &type, DataManagerCtor func)
 Register a mapping of a data manager type to its static construction function. More...
 
static DataManagerCtor getCtor (const String &dataManagerType)
 Get the "constructor" of a data manager (thread-safe). More...
 
static Bool isRegistered (const String &dataManagerType)
 Test if a data manager is registered (thread-safe). More...
 
static DataManagerunknownDataManager (const String &dataManagerType, const Record &spec)
 Serve as default function for theirRegisterMap, which catches all unknown data manager types. More...
 

Protected Member Functions

void setPersMaxCacheSize (uInt nMiB)
 Set the persistent maximum cache size (in MiB). More...
 
uInt getBindings (const Vector< String > &columnNames, PtrBlock< TSMColumn * > &colSet, Bool mustExist) const
 Get the bindings of the columns with the given names. More...
 
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. More...
 
virtual const TableDescgetDesc () const
 Get the table description needed for the hypercolumn description. More...
 
void checkValues (const PtrBlock< TSMColumn * > &colSet, const Record &values) const
 Check if values are given in the record for all columns in the block. More...
 
void checkCoordinates (const PtrBlock< TSMColumn * > &coordColSet, const IPosition &cubeShape, const Record &values) const
 Check if the coordinate values are correct. More...
 
void checkShapeColumn (const IPosition &shape) const
 Check if the shapes of FixedShape data and coordinate columns match. More...
 
void checkCoordinatesShapes (const TSMCube *hypercube, const IPosition &cubeShape) const
 Check if the cube shape matches that of defined coordinates. More...
 
void checkAddHypercube (const IPosition &cubeShape, const Record &values) const
 Check if the hypercube to be added is correctly defined. More...
 
TSMCubemakeHypercube (const IPosition &cubeShape, const IPosition &tileShape, const Record &values)
 Make a new TSMCube object. More...
 
Int getCubeIndex (const Record &idValues) const
 Get the index of the hypercube with the given id-values. More...
 
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. More...
 
Bool flushCaches (Bool fsync)
 Flush the caches of all hypercubes. More...
 
virtual void readHeader (uInt nrrow, Bool firstTime)=0
 Let a derived class read the header info. More...
 
AipsIOheaderFileCreate ()
 Create the TSM header file. More...
 
AipsIOheaderFileOpen ()
 Open the TSM header file. More...
 
void headerFilePut (AipsIO &headerFile, uInt nrCube)
 Write the data into the header file. More...
 
void headerFileGet (AipsIO &headerFile, uInt tabNrrow, Bool firstTime, Int extraNdim)
 Read the data from the header file. More...
 
void headerFileClose (AipsIO *headerFile)
 Close the header file. More...
 
void setup (Int extraNdim=-1)
 Set up the TiledStMan variables from the table description. More...
 
void createFile (uInt index)
 Create a TSMFile object and store its pointer at the given index in the block. More...
 
int arrayDataType (int dataType) const
 Convert the scalar data type to an array data type. More...
 
- Protected Member Functions inherited from casacore::DataManager
void decrementNcolumn ()
 Decrement number of columns (in case a column is deleted). More...
 
void setEndian (Bool bigEndian)
 Tell the data manager if big or little endian format is needed. More...
 
void setTsmOption (const TSMOption &tsmOption)
 Tell the data manager which TSM option to use. More...
 
void setMultiFile (MultiFileBase *mfile)
 Tell the data manager that MultiFile can be used. More...
 
void throwDataTypeOther (const String &columnName, int dataType) const
 Throw an exception in case data type is TpOther, because the storage managers (and maybe other data managers) do not support such columns. More...
 

Protected Attributes

String hypercolumnName_p
 The name of the hypercolumn. More...
 
uInt nrrow_p
 The number of rows in the columns. More...
 
PtrBlock< TSMColumn * > colSet_p
 The assembly of all columns. More...
 
PtrBlock< TSMDataColumn * > dataCols_p
 The assembly of all data columns. More...
 
PtrBlock< TSMColumn * > dataColSet_p
 
PtrBlock< TSMColumn * > idColSet_p
 The assembly of all id columns. More...
 
PtrBlock< TSMColumn * > coordColSet_p
 The assembly of all coordinate columns. More...
 
PtrBlock< TSMFile * > fileSet_p
 The assembly of all TSMFile objects. More...
 
PtrBlock< TSMCube * > cubeSet_p
 The assembly of all TSMCube objects. More...
 
uInt persMaxCacheSize_p
 The persistent maximum cache size (in MiB) for a hypercube. More...
 
uInt maxCacheSize_p
 The actual maximum cache size for a hypercube (in MiB). More...
 
uInt nrdim_p
 The dimensionality of the hypercolumn. More...
 
uInt nrCoordVector_p
 The number of vector coordinates. More...
 
IPosition fixedCellShape_p
 The fixed cell shape. More...
 
Bool dataChanged_p
 Has any data changed since the last flush? More...
 

Private Member Functions

 TiledStMan (const TiledStMan &)
 Forbid copy constructor. More...
 
TiledStManoperator= (const TiledStMan &)
 Forbid assignment. More...
 

Detailed Description

Base class for Tiled Storage Manager classes.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25

Prerequisite

Synopsis

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.

Motivation

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.

Constructor & Destructor Documentation

casacore::TiledStMan::TiledStMan ( )

Create a TiledStMan.

casacore::TiledStMan::TiledStMan ( const String hypercolumnName,
uInt  maximumCacheSizeMiB 
)

Create a TiledStMan storage manager.

The given maximum cache size (in MibiByte) 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.

Member Function Documentation

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*.

uInt casacore::TiledStMan::bucketSize ( uInt  rownr) const

Get the bucket size (in bytes) of the hypercube in the given row.

uInt casacore::TiledStMan::cacheSize ( uInt  rownr) const

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.

virtual Bool casacore::TiledStMan::canAccessColumn ( Bool reask) const
virtual

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::TiledShapeStMan, and casacore::TiledColumnStMan.

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::TiledShapeStMan, casacore::TiledCellStMan, and casacore::TiledColumnStMan.

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.

Bool casacore::TiledStMan::flushCaches ( Bool  fsync)
protected

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.

Int casacore::TiledStMan::getCubeIndex ( const Record idValues) const
protected

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
protectedvirtual

Get the table description needed for the hypercolumn description.

Reimplemented in casacore::TiledFileHelper.

TSMFile* casacore::TiledStMan::getFile ( uInt  sequenceNumber)

Get the TSMFile object with the given sequence number.

const TSMCube * casacore::TiledStMan::getHypercube ( uInt  rownr) const
inline

Get the hypercube in which the given row is stored.

Definition at line 551 of file TiledStMan.h.

virtual TSMCube* casacore::TiledStMan::getHypercube ( uInt  rownr)
pure virtual
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::TiledDataStMan, casacore::TiledShapeStMan, casacore::TiledCellStMan, casacore::TiledColumnStMan, and casacore::TiledFileHelper.

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 MaxCacheSize (the maximum cache size in MibiByte). It is a subset of the data manager specification.

Reimplemented from casacore::DataManager.

const TSMCube * casacore::TiledStMan::getTSMCube ( uInt  hypercube) const
inline

Get the given hypercube.

Definition at line 548 of file TiledStMan.h.

TSMCube* casacore::TiledStMan::getTSMCube ( uInt  hypercube)
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

Close the header file.

It deletes the AipsIO object.

AipsIO* casacore::TiledStMan::headerFileCreate ( )
protected

Create the TSM header file.

It creates an AipsIO object for it.

void casacore::TiledStMan::headerFileGet ( AipsIO headerFile,
uInt  tabNrrow,
Bool  firstTime,
Int  extraNdim 
)
protected

Read the data from the header file.

When done for the first time, setup() is called to initialize the various variables (using the extraNdim variable).

AipsIO* casacore::TiledStMan::headerFileOpen ( )
protected

Open the TSM header file.

It creates an AipsIO object for it.

void casacore::TiledStMan::headerFilePut ( AipsIO headerFile,
uInt  nrCube 
)
protected

Write the data into the header file.

The given number of TSMCube objects have to be written.

const IPosition& casacore::TiledStMan::hypercubeShape ( uInt  rownr) const

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,
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.

static IPosition casacore::TiledStMan::makeTileShape ( const IPosition hypercubeShape,
const Vector< double > &  weight,
const Vector< double > &  tolerance,
uInt  maxNrPixelsPerTile = 32768 
)
static
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 MiB (MibiByte)).

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.

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.

virtual void casacore::TiledStMan::open ( uInt  nrrow,
AipsIO  
)
virtual

Open the storage manager for an existing table.

Implements casacore::DataManager.

TiledStMan& casacore::TiledStMan::operator= ( const TiledStMan )
private

Forbid assignment.

virtual void casacore::TiledStMan::readHeader ( uInt  nrrow,
Bool  firstTime 
)
protectedpure virtual

Let a derived class read the header info.

This is used by the open and resync function.

Implemented in casacore::TiledDataStMan, casacore::TiledShapeStMan, casacore::TiledCellStMan, casacore::TiledColumnStMan, and casacore::TiledFileHelper.

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.

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::setCacheSize ( uInt  rownr,
uInt  nbuckets,
Bool  forceSmaller 
)

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::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  nMiB)
virtual

Set the maximum cache size (in MiB) in a non-persistent way.

Reimplemented from casacore::DataManager.

void casacore::TiledStMan::setPersMaxCacheSize ( uInt  nMiB)
inlineprotected

Set the persistent maximum cache size (in MiB).

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 MaxCacheSize 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::TiledShapeStMan, and casacore::TiledCellStMan.

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
protectedvirtual

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::TiledShapeStMan, casacore::TiledCellStMan, and casacore::TiledColumnStMan.

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.

const IPosition& casacore::TiledStMan::tileShape ( uInt  rownr) const

Get the tile shape of the data in the given row.

Bool casacore::TiledStMan::userSetCache ( uInt  rownr) const

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.

Member Data Documentation

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 (in MiB).

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 (in MiB) for a hypercube.

Definition at line 512 of file TiledStMan.h.

Referenced by setPersMaxCacheSize().


The documentation for this class was generated from the following file: