casa::TiledStMan Class Reference
[Tables]

#include <TiledStMan.h>

Inheritance diagram for casa::TiledStMan:

Inheritance graph
[legend]
Collaboration diagram for casa::TiledStMan:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for Tiled Storage Manager classes.

Intended use:

Part of API

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 (see TableDesc::defineHypercolumn (file="TableDesc.h::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 106 of file TiledStMan.h.

Public Member Functions

 TiledStMan ()
 Create a TiledStMan.
 TiledStMan (const String &hypercolumnName, uInt maximumCacheSize)
 Create a TiledStMan storage manager.
 ~TiledStMan ()
String dataManagerName () const
 Get the name given to the storage manager.
virtual Record dataManagerSpec () const
 Record a record containing data manager specifications.
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 IPositionhypercubeShape (uInt rownr) const
 Get the hypercube shape of the data in the given row.
const IPositiontileShape (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.
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.
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 TSMCubesingleHypercube ()
 Test if only one hypercube is used by this storage manager.
virtual TSMCubegetHypercube (uInt rownr, IPosition &position)=0
 Get the hypercube in which the given row is stored.
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.
TSMFilegetFile (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).
Bool canReallocateColumns () const
 The TiledStMan wants to do reallocateColumn.
DataManagerColumnreallocateColumn (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 TSMCubegetTSMCube (uInt hypercube) const
 Get the given hypercube.
TSMCubegetTSMCube (uInt hypercube)
const TSMCubegetHypercube (uInt rownr) const
 Get the hypercube in which the given row is stored.
virtual TSMCubegetHypercube (uInt rownr)=0
DataManagerColumnmakeScalarColumn (const String &name, int dataType, const String &dataTypeID)
 Create a scalar column.
DataManagerColumnmakeDirArrColumn (const String &name, int dataType, const String &dataTypeID)
 Create a direct array column.
DataManagerColumnmakeIndArrColumn (const String &name, int dataType, const String &dataTypeID)
 Create an indirect array column.

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 TableDescgetDesc () 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.
TSMCubemakeHypercube (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.
AipsIOheaderFileCreate ()
 Create the TSM header file.
AipsIOheaderFileOpen ()
 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.
TiledStManoperator= (const TiledStMan &)
 Forbid assignment.


Constructor & Destructor Documentation

casa::TiledStMan::TiledStMan (  ) 

Create a TiledStMan.

casa::TiledStMan::TiledStMan ( const String hypercolumnName,
uInt  maximumCacheSize 
)

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.

casa::TiledStMan::~TiledStMan (  ) 

casa::TiledStMan::TiledStMan ( const TiledStMan  )  [private]

Forbid copy constructor.


Member Function Documentation

String casa::TiledStMan::dataManagerName (  )  const [virtual]

Get the name given to the storage manager.

This is the name of the hypercolumn.

Reimplemented from casa::DataManager.

virtual Record casa::TiledStMan::dataManagerSpec (  )  const [virtual]

Record a record containing data manager specifications.

Reimplemented from casa::DataManager.

void casa::TiledStMan::setDataChanged (  )  [inline]

Set the flag to "data has changed since last flush".

Definition at line 517 of file TiledStMan.h.

References dataChanged_p, and casa::True.

static IPosition casa::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 casa::TiledStMan::makeTileShape ( const IPosition hypercubeShape,
const Vector< double > &  weight,
const Vector< double > &  tolerance,
uInt  maxNrPixelsPerTile = 32768 
) [static]

virtual void casa::TiledStMan::setMaximumCacheSize ( uInt  nbytes  )  [virtual]

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

Reimplemented from casa::DataManager.

uInt casa::TiledStMan::maximumCacheSize (  )  const [inline]

Get the current maximum cache size (in bytes).

Definition at line 505 of file TiledStMan.h.

References maxCacheSize_p.

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

Get the current cache size (in buckets) for the hypercube in the given row.

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

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

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

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

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

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

virtual Bool casa::TiledStMan::canChangeShape (  )  const [virtual]

Can the tiled storage manager handle changing array shapes? The default is no (but TiledCellStMan can).

virtual Bool casa::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).

uInt casa::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.

void casa::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 casa::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.

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

Determine if the user set the cache size (using setCacheSize).

void casa::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.

void casa::TiledStMan::showCacheStatistics ( ostream &  os  )  const

Show the statistics of all caches used.

uInt casa::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.

uInt casa::TiledStMan::nrCoordVector (  )  const [inline]

Get the number of coordinate vectors.

Definition at line 508 of file TiledStMan.h.

References nrCoordVector_p.

uInt casa::TiledStMan::nrow (  )  const [inline]

Get the nr of rows in this storage manager.

Definition at line 511 of file TiledStMan.h.

References nrrow_p.

Bool casa::TiledStMan::canAddRow (  )  const [virtual]

Does the storage manager allow to add rows? (yes).

Reimplemented from casa::DataManager.

virtual IPosition casa::TiledStMan::defaultTileShape (  )  const [virtual]

Get the default tile shape.

By default it returns a zero-length IPosition.

uInt casa::TiledStMan::nhypercubes (  )  const [inline]

Return the number of hypercubes.

Definition at line 514 of file TiledStMan.h.

References cubeSet_p.

virtual TSMCube* casa::TiledStMan::singleHypercube (  )  [virtual]

Test if only one hypercube is used by this storage manager.

If not, throw an exception. Otherwise return the hypercube.

const TSMCube * casa::TiledStMan::getTSMCube ( uInt  hypercube  )  const [inline]

Get the given hypercube.

Definition at line 520 of file TiledStMan.h.

TSMCube* casa::TiledStMan::getTSMCube ( uInt  hypercube  ) 

const TSMCube * casa::TiledStMan::getHypercube ( uInt  rownr  )  const [inline]

Get the hypercube in which the given row is stored.

Definition at line 523 of file TiledStMan.h.

virtual TSMCube* casa::TiledStMan::getHypercube ( uInt  rownr  )  [pure virtual]

virtual TSMCube* casa::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.

void casa::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.

void casa::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.

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

Get the TSMFile object with the given sequence number.

virtual void casa::TiledStMan::open ( uInt  nrrow,
AipsIO  
) [virtual]

Open the storage manager for an existing table.

Implements casa::DataManager.

virtual void casa::TiledStMan::resync ( uInt  nrrow  )  [virtual]

Resync the storage manager with the new file contents.

Implements casa::DataManager.

virtual void casa::TiledStMan::reopenRW (  )  [virtual]

Reopen all files used in this storage manager for read/write access.

Reimplemented from casa::DataManager.

virtual void casa::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 casa::DataManager.

DataManagerColumn* casa::TiledStMan::makeScalarColumn ( const String name,
int  dataType,
const String dataTypeID 
) [virtual]

Create a scalar column.

Implements casa::DataManager.

DataManagerColumn* casa::TiledStMan::makeDirArrColumn ( const String name,
int  dataType,
const String dataTypeID 
) [virtual]

Create a direct array column.

Implements casa::DataManager.

DataManagerColumn* casa::TiledStMan::makeIndArrColumn ( const String name,
int  dataType,
const String dataTypeID 
) [virtual]

Create an indirect array column.

Implements casa::DataManager.

Bool casa::TiledStMan::canReallocateColumns (  )  const [virtual]

The TiledStMan wants to do reallocateColumn.

Reimplemented from casa::DataManager.

DataManagerColumn* casa::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 casa::DataManager.

virtual void casa::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.

void casa::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.

int casa::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 casa::TiledStMan::initCoordinates ( TSMCube hypercube  ) 

Initialize the new coordinates for the given cube.

void casa::TiledStMan::setPersMaxCacheSize ( uInt  nbytes  )  [inline, protected]

Set the persistent maximum cache size.

Definition at line 526 of file TiledStMan.h.

References maxCacheSize_p, and persMaxCacheSize_p.

uInt casa::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.

virtual void casa::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.

virtual const TableDesc& casa::TiledStMan::getDesc (  )  const [protected, virtual]

Get the table description needed for the hypercolumn description.

void casa::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.

void casa::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 casa::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 casa::TiledStMan::checkCoordinatesShapes ( const TSMCube hypercube,
const IPosition cubeShape 
) const [protected]

Check if the cube shape matches that of defined coordinates.

void casa::TiledStMan::checkAddHypercube ( const IPosition cubeShape,
const Record values 
) const [protected]

Check if the hypercube to be added is correctly defined.

TSMCube* casa::TiledStMan::makeHypercube ( const IPosition cubeShape,
const IPosition tileShape,
const Record values 
) [protected]

Make a new TSMCube object.

Int casa::TiledStMan::getCubeIndex ( const Record idValues  )  const [protected]

Get the index of the hypercube with the given id-values.

If not found, -1 is returned.

uInt casa::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.

Bool casa::TiledStMan::flushCaches ( Bool  fsync  )  [protected]

Flush the caches of all hypercubes.

If data have put and fsync is set, fsync all files.

virtual void casa::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.

AipsIO* casa::TiledStMan::headerFileCreate (  )  [protected]

Create the TSM header file.

It creates an AipsIO object for it.

AipsIO* casa::TiledStMan::headerFileOpen (  )  [protected]

Open the TSM header file.

It creates an AipsIO object for it.

void casa::TiledStMan::headerFilePut ( AipsIO headerFile,
uInt  nrCube 
) [protected]

Write the data into the header file.

The given number of TSMCube objects have to be written.

void casa::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).

void casa::TiledStMan::headerFileClose ( AipsIO headerFile  )  [protected]

Close the header file.

It deletes the AipsIO object.

void casa::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.

void casa::TiledStMan::createFile ( uInt  index  )  [protected]

Create a TSMFile object and store its pointer at the given index in the block.

int casa::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*.

TiledStMan& casa::TiledStMan::operator= ( const TiledStMan  )  [private]

Forbid assignment.


Member Data Documentation

String casa::TiledStMan::hypercolumnName_p [protected]

The name of the hypercolumn.

Definition at line 465 of file TiledStMan.h.

uInt casa::TiledStMan::nrrow_p [protected]

The number of rows in the columns.

Definition at line 467 of file TiledStMan.h.

Referenced by nrow().

PtrBlock<TSMColumn*> casa::TiledStMan::colSet_p [protected]

The assembly of all columns.

Definition at line 469 of file TiledStMan.h.

PtrBlock<TSMDataColumn*> casa::TiledStMan::dataCols_p [protected]

The assembly of all data columns.

Definition at line 471 of file TiledStMan.h.

PtrBlock<TSMColumn*> casa::TiledStMan::dataColSet_p [protected]

Definition at line 472 of file TiledStMan.h.

PtrBlock<TSMColumn*> casa::TiledStMan::idColSet_p [protected]

The assembly of all id columns.

Definition at line 474 of file TiledStMan.h.

PtrBlock<TSMColumn*> casa::TiledStMan::coordColSet_p [protected]

The assembly of all coordinate columns.

Definition at line 476 of file TiledStMan.h.

PtrBlock<TSMFile*> casa::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 480 of file TiledStMan.h.

Referenced by casa::TiledFileHelper::file().

PtrBlock<TSMCube*> casa::TiledStMan::cubeSet_p [protected]

The assembly of all TSMCube objects.

Definition at line 482 of file TiledStMan.h.

Referenced by nhypercubes().

uInt casa::TiledStMan::persMaxCacheSize_p [protected]

The persistent maximum cache size for a hypercube.

Definition at line 484 of file TiledStMan.h.

Referenced by setPersMaxCacheSize().

uInt casa::TiledStMan::maxCacheSize_p [protected]

The actual maximum cache size for a hypercube.

Definition at line 486 of file TiledStMan.h.

Referenced by maximumCacheSize(), and setPersMaxCacheSize().

uInt casa::TiledStMan::nrdim_p [protected]

The dimensionality of the hypercolumn.

Definition at line 488 of file TiledStMan.h.

uInt casa::TiledStMan::nrCoordVector_p [protected]

The number of vector coordinates.

Definition at line 490 of file TiledStMan.h.

Referenced by nrCoordVector().

IPosition casa::TiledStMan::fixedCellShape_p [protected]

The fixed cell shape.

Definition at line 492 of file TiledStMan.h.

Bool casa::TiledStMan::dataChanged_p [protected]

Has any data changed since the last flush?

Definition at line 494 of file TiledStMan.h.

Referenced by setDataChanged().


The documentation for this class was generated from the following file:
Generated on Mon Sep 1 22:45:51 2008 for NRAOCASA by  doxygen 1.5.1