casacore
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::BaseMappedArrayEngine< VirtualType, StoredType > Class Template Reference

More...

#include <BaseMappedArrayEngine.h>

Public Member Functions

const StringvirtualName () const
 Get the virtual column name. More...
 
const StringstoredName () const
 Get the stored column name. More...
 
virtual Bool isWritable () const
 The column is writable if the underlying stored column is writable. More...
 
- Public Member Functions inherited from casacore::VirtualColumnEngine
 VirtualColumnEngine ()
 Create the object. More...
 
virtual ~VirtualColumnEngine ()
 
- 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 dataManagerName () const
 Return the name of the data manager. 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 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 given in record fields. More...
 
virtual Bool canReallocateColumns () const
 Tell if the data manager wants to reallocate the data manager column objects. More...
 
virtual DataManagerColumnreallocateColumn (DataManagerColumn *column)
 Reallocate the column object if it is part of this data manager. 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 void reopenRW ()
 Reopen the data manager for read/write access. 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 setMaximumCacheSize (uInt nMiB)
 Set the maximum cache size (in bytes) to be used by a storage manager. 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...
 
- Public Member Functions inherited from casacore::VirtualArrayColumn< VirtualType >
 VirtualArrayColumn ()
 Create a column. More...
 
virtual ~VirtualArrayColumn ()
 
virtual int dataType () const
 Return the data type of the column. More...
 
virtual String dataTypeId () const
 Return the data type Id of the column. More...
 
- Public Member Functions inherited from casacore::VirtualArrayColumnBase
 VirtualArrayColumnBase ()
 Create a column. More...
 
virtual ~VirtualArrayColumnBase ()
 
- Public Member Functions inherited from casacore::DataManagerColumn
 DataManagerColumn ()
 Create a column. More...
 
virtual ~DataManagerColumn ()
 Frees up the storage. More...
 
void setIsFixedShape (Bool isFixedShape)
 Set the isFixedShape flag. More...
 
Bool isFixedShape () const
 Is this a fixed shape column? More...
 
virtual void setMaxLength (uInt maxLength)
 Set the maximum length of the value (can be used for strings). More...
 
void setFixedShapeColumn (const IPosition &shape)
 Set the shape of all (fixed-shaped) arrays in the column. More...
 
virtual void setShapeTiled (rownr_t rownr, const IPosition &shape, const IPosition &tileShape)
 Set the shape and tile shape of an (variable-shaped) array in the given row. More...
 
virtual IPosition tileShape (rownr_t rownr)
 Get the tile shape of the item in the given row. More...
 
ColumnCachecolumnCache ()
 Get access to the ColumnCache object. More...
 
const ColumnCachecolumnCachePtr () const
 
void get (rownr_t rownr, Bool *dataPtr)
 Get the scalar value in the given row. More...
 
void get (rownr_t rownr, uChar *dataPtr)
 
void get (rownr_t rownr, Short *dataPtr)
 
void get (rownr_t rownr, uShort *dataPtr)
 
void get (rownr_t rownr, Int *dataPtr)
 
void get (rownr_t rownr, uInt *dataPtr)
 
void get (rownr_t rownr, Int64 *dataPtr)
 
void get (rownr_t rownr, float *dataPtr)
 
void get (rownr_t rownr, double *dataPtr)
 
void get (rownr_t rownr, Complex *dataPtr)
 
void get (rownr_t rownr, DComplex *dataPtr)
 
void get (rownr_t rownr, String *dataPtr)
 
void get (rownr_t rownr, void *dataPtr)
 This function is the get for all non-standard data types. More...
 
void put (rownr_t rownr, const Bool *dataPtr)
 Put the scalar value into the given row. More...
 
void put (rownr_t rownr, const uChar *dataPtr)
 
void put (rownr_t rownr, const Short *dataPtr)
 
void put (rownr_t rownr, const uShort *dataPtr)
 
void put (rownr_t rownr, const Int *dataPtr)
 
void put (rownr_t rownr, const uInt *dataPtr)
 
void put (rownr_t rownr, const Int64 *dataPtr)
 
void put (rownr_t rownr, const float *dataPtr)
 
void put (rownr_t rownr, const double *dataPtr)
 
void put (rownr_t rownr, const Complex *dataPtr)
 
void put (rownr_t rownr, const DComplex *dataPtr)
 
void put (rownr_t rownr, const String *dataPtr)
 
void put (rownr_t rownr, const void *dataPtr)
 This function is the put for all non-standard data types. More...
 
void throwGet () const
 Throw an "invalid operation" exception for the default implementation of get. More...
 
void throwPut () const
 Throw an "invalid operation" exception for the default implementation of put. More...
 
void setColumnName (const String &colName)
 Set the column name. More...
 
const StringcolumnName () const
 Get rhe column name. More...
 

Protected Member Functions

 BaseMappedArrayEngine (const String &virtualColumnName, const String &storedColumnName)
 Construct an engine to convert the virtual column to the stored column. More...
 
 ~BaseMappedArrayEngine ()
 Destructor is mandatory. More...
 
 BaseMappedArrayEngine ()
 The default constructor is required for reconstruction of the engine when a table is read back. More...
 
 BaseMappedArrayEngine (const BaseMappedArrayEngine< VirtualType, StoredType > &)
 Copy constructor is only used by copy constructor of derived classes. More...
 
void setWritable (Bool isWritable)
 Set if the column is writable or not. More...
 
void setNames (const String &virtualName, const String &storedName)
 Set the virtual and stored column name. More...
 
ArrayColumn< StoredType > & column ()
 Give access to the stored column. More...
 
virtual DataManagerColumnmakeIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create the column object for the array column in this engine. More...
 
virtual void create64 (rownr_t initialNrrow)
 Initialize the object for a new table. More...
 
virtual void prepare ()
 Preparing consists of setting the writable switch and adding the initial number of rows in case of create. More...
 
void prepare1 ()
 Do the 2 stages of the prepare (define columns and adding rows). More...
 
void prepare2 ()
 
virtual void addRow64 (rownr_t nrrow)
 Rows are added to the end of the table. More...
 
virtual void addRowInit (rownr_t startRow, rownr_t nrrow)
 
virtual void setShapeColumn (const IPosition &shape)
 Set the shape of the FixedShape arrays in the column. More...
 
virtual void setShape (rownr_t rownr, const IPosition &shape)
 Define the shape of the array in the given row. More...
 
virtual Bool isShapeDefined (rownr_t rownr)
 Test if the (underlying) array is defined in the given row. More...
 
virtual uInt ndim (rownr_t rownr)
 Get the dimensionality of the (underlying) array in the given row. More...
 
virtual IPosition shape (rownr_t rownr)
 Get the shape of the (underlying) array in the given row. More...
 
virtual Bool canChangeShape () const
 The data manager can handle changing the shape of an existing array when the underlying stored column can do it. More...
 
TableColumn makeTableColumn (const String &columnName)
 Make a table column object for the given column. More...
 
virtual void getArray (rownr_t rownr, Array< VirtualType > &array)
 Get an array in the given row. More...
 
virtual void putArray (rownr_t rownr, const Array< VirtualType > &array)
 Put an array in the given row. More...
 
virtual void getSlice (rownr_t rownr, const Slicer &slicer, Array< VirtualType > &array)
 Get a section of the array in the given row. More...
 
virtual void putSlice (rownr_t rownr, const Slicer &slicer, const Array< VirtualType > &array)
 Put into a section of the array in the given row. More...
 
virtual void getArrayColumn (Array< VirtualType > &array)
 Get an entire column. More...
 
virtual void putArrayColumn (const Array< VirtualType > &array)
 Put an entire column. More...
 
virtual void getArrayColumnCells (const RefRows &rownrs, Array< VirtualType > &data)
 Get some array values in the column. More...
 
virtual void putArrayColumnCells (const RefRows &rownrs, const Array< VirtualType > &data)
 Put some array values in the column. More...
 
void getColumnSlice (const Slicer &slicer, Array< VirtualType > &array)
 Get a section of all arrays in the column. More...
 
void putColumnSlice (const Slicer &slicer, const Array< VirtualType > &array)
 Put a section of all arrays in the column. More...
 
virtual void getColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, Array< VirtualType > &data)
 Get a section of some arrays in the column. More...
 
virtual void putColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, const Array< VirtualType > &data)
 Put into a section of some arrays in the column. More...
 
virtual IPosition getStoredShape (rownr_t rownr, const IPosition &virtualShape)
 Map the virtual shape to the stored shape. More...
 
virtual Slicer getStoredSlicer (const Slicer &virtualSlicer) const
 Map the slicer for a virtual shape to a stored shape. More...
 
virtual void mapOnGet (Array< VirtualType > &array, const Array< StoredType > &stored)
 Map StoredType array to VirtualType array. More...
 
virtual void mapOnPut (const Array< VirtualType > &array, Array< StoredType > &stored)
 Map Bool array to bit flags array. 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...
 
virtual Bool hasMultiFileSupport () const
 Does the data manager support use of MultiFile? A derived class has to return True if it can use the MultiFile. 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 Member Functions inherited from casacore::VirtualArrayColumnBase
virtual void getScalarColumnV (ArrayBase &dataPtr)
 The scalar access functions throw an exception. More...
 
virtual void putScalarColumnV (const ArrayBase &dataPtr)
 Put all scalar values in the column. More...
 
virtual void getScalarColumnCellsV (const RefRows &rownrs, ArrayBase &dataPtr)
 Get some scalar values in the column. More...
 
virtual void putScalarColumnCellsV (const RefRows &rownrs, const ArrayBase &dataPtr)
 Put some scalar values in the column. More...
 
- Protected Member Functions inherited from casacore::DataManagerColumn
virtual void getBool (rownr_t rownr, Bool *dataPtr)
 Get the scalar value in the given row. More...
 
virtual void getuChar (rownr_t rownr, uChar *dataPtr)
 
virtual void getShort (rownr_t rownr, Short *dataPtr)
 
virtual void getuShort (rownr_t rownr, uShort *dataPtr)
 
virtual void getInt (rownr_t rownr, Int *dataPtr)
 
virtual void getuInt (rownr_t rownr, uInt *dataPtr)
 
virtual void getInt64 (rownr_t rownr, Int64 *dataPtr)
 
virtual void getfloat (rownr_t rownr, float *dataPtr)
 
virtual void getdouble (rownr_t rownr, double *dataPtr)
 
virtual void getComplex (rownr_t rownr, Complex *dataPtr)
 
virtual void getDComplex (rownr_t rownr, DComplex *dataPtr)
 
virtual void getString (rownr_t rownr, String *dataPtr)
 
virtual void getOther (rownr_t rownr, void *dataPtr)
 This function is the get for all non-standard data types. More...
 
virtual void putBool (rownr_t rownr, const Bool *dataPtr)
 Put the scalar value into the given row. More...
 
virtual void putuChar (rownr_t rownr, const uChar *dataPtr)
 
virtual void putShort (rownr_t rownr, const Short *dataPtr)
 
virtual void putuShort (rownr_t rownr, const uShort *dataPtr)
 
virtual void putInt (rownr_t rownr, const Int *dataPtr)
 
virtual void putuInt (rownr_t rownr, const uInt *dataPtr)
 
virtual void putInt64 (rownr_t rownr, const Int64 *dataPtr)
 
virtual void putfloat (rownr_t rownr, const float *dataPtr)
 
virtual void putdouble (rownr_t rownr, const double *dataPtr)
 
virtual void putComplex (rownr_t rownr, const Complex *dataPtr)
 
virtual void putDComplex (rownr_t rownr, const DComplex *dataPtr)
 
virtual void putString (rownr_t rownr, const String *dataPtr)
 
virtual void putOther (rownr_t rownr, const void *dataPtr)
 This function is the put for all non-standard data types. More...
 
void getScalarColumnBase (ArrayBase &dataPtr)
 The default implementations of get and put functions. More...
 
void putScalarColumnBase (const ArrayBase &dataPtr)
 
void getScalarColumnCellsBase (const RefRows &rownrs, ArrayBase &dataPtr)
 
void putScalarColumnCellsBase (const RefRows &rownrs, const ArrayBase &dataPtr)
 
void getArrayColumnBase (ArrayBase &data)
 
void putArrayColumnBase (const ArrayBase &data)
 
void getArrayColumnCellsBase (const RefRows &rownrs, ArrayBase &data)
 
void putArrayColumnCellsBase (const RefRows &rownrs, const ArrayBase &data)
 
void getSliceBase (rownr_t rownr, const Slicer &slicer, ArrayBase &data)
 
void putSliceBase (rownr_t rownr, const Slicer &slicer, const ArrayBase &data)
 
void getColumnSliceBase (const Slicer &slicer, ArrayBase &data)
 
void putColumnSliceBase (const Slicer &slicer, const ArrayBase &data)
 
void getColumnSliceCellsBase (const RefRows &rownrs, const Slicer &slicer, ArrayBase &data)
 
void putColumnSliceCellsBase (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &data)
 

Private Member Functions

BaseMappedArrayEngine< VirtualType, StoredType > & operator= (const BaseMappedArrayEngine< VirtualType, StoredType > &)
 Assignment is not needed and therefore forbidden (so it is made private and not implemented). More...
 

Private Attributes

String virtualName_p
 
String storedName_p
 
Bool isWritable_p
 
Bool tempWritable_p
 
rownr_t initialNrrow_p
 
Bool arrayIsFixed_p
 
IPosition shapeFixed_p
 
ArrayColumn< StoredType > * column_p
 

Additional Inherited Members

- 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...
 
- Static Public Attributes inherited from casacore::DataManager
static rownr_t MAXROWNR32
 Define the highest row number that can be represented as signed 32-bit. More...
 

Detailed Description

template<class VirtualType, class StoredType>
class casacore::BaseMappedArrayEngine< VirtualType, StoredType >

Templated virtual column engine for a table array of any type.

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

BaseMappedArrayEngine contains for the 1-1 mapping of a virtual column to a stored column (both containing arrays).

Synopsis

BaseMappedArrayEngine is an abstract base class for virtual column engines which map data from the arrays in the virtual column to the arrays in the stored column. Note the the stored column does not need to be stored; it can be another virtual column, but usually it will be a stored column. Examples of classes using this base class are ScaledArrayEngine and RetypedArrayEngine.

The virtual column has to be bound to the virtual column engine used for it. The stored column will usually be bound to a storage manager, but any other suitable data manager is possible. E.g. it is possible to use MappedArrayEngine<StokesVector,float> to map a StokesVector to a float column, which in its turn uses ScaledArrayEngine<float,Int> to store it as integers. Note that the names of the virtual and stored column have to be different, otherwise the table system cannot distinguish them.

This base class does several tasks for the derived classes. The main one is to keep and handle the information about the virtual and stored column. The name of the stored column is written as a keyword in the virtual column. In this way the stored column is known when a table is read back. It also creates (RO)ArrayColumn<T> objects to access the stored column. The function roColumn gives read access, while rwColumn gives write access.

An engine object should be used for one column only, because the stored column name is part of the engine. If it would be used for more than one column, they would all share the same stored column. When the engine is bound to a column, it is checked if the name of that column matches the given virtual column name.

The engine can be used for a column containing any kind of array (thus direct or indirect, fixed or variable shaped)) as long as the virtual array can be stored in the stored array. Thus a fixed shaped virtual can use a variable shaped stored, but not vice versa. A fixed shape indirect virtual can use a stored with direct arrays.

The DataManager framework contains various virtual functions. This class implements several, but not all of them. Furthermore some implementations may not be optimal or correct for derived classes. Hereafter follows a list of functions which may need implementation in derived classes. The classes mentioned in the examples below show implementations of these functions.

Example

The derived classes ScaledArrayEngine and RetypedArrayEngine are two examples of how to derive a class from this base class. Note that ScaledArrayEngine does not need to implement functions dealing with shapes, because it can use them from this base class. On the other hand they need to be implemented in RetypedArrayEngine.

Motivation

This base class implements several functions making the implementation of derived classes simpler. Many details are implemented here, so often only the basic mapping functions (get, put) need to be implemented in a derived class.

Template Type Argument Requirements (VirtualType)

Template Type Argument Requirements (StoredType)

Definition at line 265 of file BaseMappedArrayEngine.h.

Constructor & Destructor Documentation

◆ BaseMappedArrayEngine() [1/3]

template<class VirtualType , class StoredType >
casacore::BaseMappedArrayEngine< VirtualType, StoredType >::BaseMappedArrayEngine ( const String virtualColumnName,
const String storedColumnName 
)
protected

Construct an engine to convert the virtual column to the stored column.

StoredColumnName is the name of the column where the converted data will be put and must have data type StoredType. The virtual column using this engine must have data type VirtualType. By default the virtual column is assumed to be writable. Use setWritable to unset it.

◆ ~BaseMappedArrayEngine()

template<class VirtualType , class StoredType >
casacore::BaseMappedArrayEngine< VirtualType, StoredType >::~BaseMappedArrayEngine ( )
protected

Destructor is mandatory.

◆ BaseMappedArrayEngine() [2/3]

template<class VirtualType , class StoredType >
casacore::BaseMappedArrayEngine< VirtualType, StoredType >::BaseMappedArrayEngine ( )
protected

The default constructor is required for reconstruction of the engine when a table is read back.

◆ BaseMappedArrayEngine() [3/3]

template<class VirtualType , class StoredType >
casacore::BaseMappedArrayEngine< VirtualType, StoredType >::BaseMappedArrayEngine ( const BaseMappedArrayEngine< VirtualType, StoredType > &  )
protected

Copy constructor is only used by copy constructor of derived classes.

(so it is made protected).

Member Function Documentation

◆ addRow64()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::addRow64 ( rownr_t  nrrow)
protectedvirtual

Rows are added to the end of the table.

If the virtual column has FixedShape arrays and the stored not, the shape in each stored row will be set. This assures that the arrays are properly defined in each row, so putSlice can be used without problems.
The second version is used by prepare2, because in case a column is added to an already existing table, table.nrow() gives the existing number of columns instead of 0.

Reimplemented from casacore::VirtualColumnEngine.

◆ addRowInit()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::addRowInit ( rownr_t  startRow,
rownr_t  nrrow 
)
protectedvirtual

◆ canChangeShape()

template<class VirtualType , class StoredType >
virtual Bool casacore::BaseMappedArrayEngine< VirtualType, StoredType >::canChangeShape ( ) const
protectedvirtual

The data manager can handle changing the shape of an existing array when the underlying stored column can do it.

Reimplemented from casacore::DataManagerColumn.

◆ column()

template<class VirtualType , class StoredType >
ArrayColumn< StoredType > & casacore::BaseMappedArrayEngine< VirtualType, StoredType >::column
inlineprotected

Give access to the stored column.

This can be used by the derived classes to get/put data.

Definition at line 514 of file BaseMappedArrayEngine.h.

◆ create64()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::create64 ( rownr_t  initialNrrow)
protectedvirtual

Initialize the object for a new table.

It defines a virtual column keyword telling the stored column name. Initially the table has the given number of rows. A derived class can have its own create function, but that should always call this create function.

Reimplemented from casacore::VirtualColumnEngine.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::CompressFloat, casacore::CompressComplexSD, casacore::CompressComplex, and casacore::BitFlagsEngine< StoredType >.

◆ getArray()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getArray ( rownr_t  rownr,
Array< VirtualType > &  array 
)
protectedvirtual

◆ getArrayColumn()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getArrayColumn ( Array< VirtualType > &  array)
protectedvirtual

◆ getArrayColumnCells()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getArrayColumnCells ( const RefRows rownrs,
Array< VirtualType > &  data 
)
protectedvirtual

Get some array values in the column.

This will scale and offset from the underlying array.

Reimplemented from casacore::VirtualArrayColumn< VirtualType >.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, casacore::CompressFloat, casacore::CompressComplex, and casacore::BitFlagsEngine< StoredType >.

◆ getColumnSlice()

template<class VirtualType , class StoredType >
void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getColumnSlice ( const Slicer slicer,
Array< VirtualType > &  array 
)
protectedvirtual

Get a section of all arrays in the column.

This will scale and offset from the underlying array.

Reimplemented from casacore::VirtualArrayColumn< VirtualType >.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, and casacore::ScaledArrayEngine< VirtualType, StoredType >.

◆ getColumnSliceCells()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getColumnSliceCells ( const RefRows rownrs,
const Slicer slicer,
Array< VirtualType > &  data 
)
protectedvirtual

Get a section of some arrays in the column.

This will scale and offset from the underlying array.

Reimplemented from casacore::VirtualArrayColumn< VirtualType >.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, casacore::CompressFloat, casacore::CompressComplex, and casacore::BitFlagsEngine< StoredType >.

◆ getSlice()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getSlice ( rownr_t  rownr,
const Slicer slicer,
Array< VirtualType > &  array 
)
protectedvirtual

◆ getStoredShape()

template<class VirtualType , class StoredType >
virtual IPosition casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getStoredShape ( rownr_t  rownr,
const IPosition virtualShape 
)
protectedvirtual

Map the virtual shape to the stored shape.

By default is returns the virtual shape.

Reimplemented in casacore::RetypedArrayEngine< VirtualType, StoredType >.

◆ getStoredSlicer()

template<class VirtualType , class StoredType >
virtual Slicer casacore::BaseMappedArrayEngine< VirtualType, StoredType >::getStoredSlicer ( const Slicer virtualSlicer) const
protectedvirtual

Map the slicer for a virtual shape to a stored shape.

By default it returns the virtual input slicer.

Reimplemented in casacore::RetypedArrayEngine< VirtualType, StoredType >.

◆ isShapeDefined()

template<class VirtualType , class StoredType >
virtual Bool casacore::BaseMappedArrayEngine< VirtualType, StoredType >::isShapeDefined ( rownr_t  rownr)
protectedvirtual

Test if the (underlying) array is defined in the given row.

Reimplemented from casacore::VirtualArrayColumnBase.

◆ isWritable()

template<class VirtualType , class StoredType >
virtual Bool casacore::BaseMappedArrayEngine< VirtualType, StoredType >::isWritable ( ) const
virtual

The column is writable if the underlying stored column is writable.

Reimplemented from casacore::VirtualArrayColumnBase.

◆ makeIndArrColumn()

template<class VirtualType , class StoredType >
virtual DataManagerColumn* casacore::BaseMappedArrayEngine< VirtualType, StoredType >::makeIndArrColumn ( const String columnName,
int  dataType,
const String dataTypeId 
)
protectedvirtual

Create the column object for the array column in this engine.

It will check if the given column name matches the virtual column name. This assures that the engine is bound to the correct column.

Reimplemented from casacore::VirtualColumnEngine.

◆ makeTableColumn()

template<class VirtualType , class StoredType >
TableColumn casacore::BaseMappedArrayEngine< VirtualType, StoredType >::makeTableColumn ( const String columnName)
protected

Make a table column object for the given column.

This has to be used in the create function, otherwise it could not create a TableColumn object to store data in the column keywords.

◆ mapOnGet()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::mapOnGet ( Array< VirtualType > &  array,
const Array< StoredType > &  stored 
)
protectedvirtual

Map StoredType array to VirtualType array.

This is meant when reading an array from the stored column. The default implementation throws an exception.

Reimplemented in casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::MappedArrayEngine< VirtualType, StoredType >, and casacore::BitFlagsEngine< StoredType >.

◆ mapOnPut()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::mapOnPut ( const Array< VirtualType > &  array,
Array< StoredType > &  stored 
)
protectedvirtual

Map Bool array to bit flags array.

This is meant when writing an array into the stored column. The default implementation throws an exception.

Reimplemented in casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::MappedArrayEngine< VirtualType, StoredType >, and casacore::BitFlagsEngine< StoredType >.

◆ ndim()

template<class VirtualType , class StoredType >
virtual uInt casacore::BaseMappedArrayEngine< VirtualType, StoredType >::ndim ( rownr_t  rownr)
protectedvirtual

Get the dimensionality of the (underlying) array in the given row.

This implementation assumes the dimensionality of virtual and stored arrays are the same. If not, it has to be overidden in a derived class.

Reimplemented from casacore::DataManagerColumn.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, and casacore::RetypedArrayEngine< VirtualType, StoredType >.

◆ operator=()

template<class VirtualType , class StoredType >
BaseMappedArrayEngine<VirtualType, StoredType>& casacore::BaseMappedArrayEngine< VirtualType, StoredType >::operator= ( const BaseMappedArrayEngine< VirtualType, StoredType > &  )
private

Assignment is not needed and therefore forbidden (so it is made private and not implemented).

◆ prepare()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::prepare ( )
protectedvirtual

Preparing consists of setting the writable switch and adding the initial number of rows in case of create.

It reads the stored column name from the virtual column keywords. A derived class can have its own prepare function, but that should always call this prepare function.

Reimplemented from casacore::VirtualColumnEngine.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::CompressFloat, casacore::CompressComplex, and casacore::BitFlagsEngine< StoredType >.

◆ prepare1()

template<class VirtualType , class StoredType >
void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::prepare1 ( )
protected

Do the 2 stages of the prepare (define columns and adding rows).

◆ prepare2()

template<class VirtualType , class StoredType >
void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::prepare2 ( )
protected

◆ putArray()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::putArray ( rownr_t  rownr,
const Array< VirtualType > &  array 
)
protectedvirtual

◆ putArrayColumn()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::putArrayColumn ( const Array< VirtualType > &  array)
protectedvirtual

◆ putArrayColumnCells()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::putArrayColumnCells ( const RefRows rownrs,
const Array< VirtualType > &  data 
)
protectedvirtual

Put some array values in the column.

This will scale and offset to the underlying array.

Reimplemented from casacore::VirtualArrayColumn< VirtualType >.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, casacore::CompressFloat, casacore::CompressComplex, and casacore::BitFlagsEngine< StoredType >.

◆ putColumnSlice()

template<class VirtualType , class StoredType >
void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::putColumnSlice ( const Slicer slicer,
const Array< VirtualType > &  array 
)
protectedvirtual

Put a section of all arrays in the column.

This will scale and offset to the underlying array.

Reimplemented from casacore::VirtualArrayColumn< VirtualType >.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, and casacore::ScaledArrayEngine< VirtualType, StoredType >.

◆ putColumnSliceCells()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::putColumnSliceCells ( const RefRows rownrs,
const Slicer slicer,
const Array< VirtualType > &  data 
)
protectedvirtual

Put into a section of some arrays in the column.

This will scale and offset to the underlying array.

Reimplemented from casacore::VirtualArrayColumn< VirtualType >.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, casacore::CompressFloat, casacore::CompressComplex, and casacore::BitFlagsEngine< StoredType >.

◆ putSlice()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::putSlice ( rownr_t  rownr,
const Slicer slicer,
const Array< VirtualType > &  array 
)
protectedvirtual

◆ setNames()

template<class VirtualType , class StoredType >
void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::setNames ( const String virtualName,
const String storedName 
)
inlineprotected

Set the virtual and stored column name.

Definition at line 500 of file BaseMappedArrayEngine.h.

◆ setShape()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::setShape ( rownr_t  rownr,
const IPosition shape 
)
protectedvirtual

Define the shape of the array in the given row.

It will define the shape of the (underlying) array. This implementation assumes the shape of virtual and stored arrays are the same. If not, it has to be overidden in a derived class.

Reimplemented from casacore::VirtualArrayColumnBase.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, and casacore::RetypedArrayEngine< VirtualType, StoredType >.

◆ setShapeColumn()

template<class VirtualType , class StoredType >
virtual void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::setShapeColumn ( const IPosition shape)
protectedvirtual

Set the shape of the FixedShape arrays in the column.

This function only gets called if the column has FixedShape arrays. The shape gets saved and used to set the shape of the arrays in the stored in case the stored has non-FixedShape arrays. This implementation assumes the shape of virtual and stored arrays are the same. If not, it has to be overidden in a derived class.

Reimplemented from casacore::VirtualArrayColumnBase.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, and casacore::RetypedArrayEngine< VirtualType, StoredType >.

◆ setWritable()

template<class VirtualType , class StoredType >
void casacore::BaseMappedArrayEngine< VirtualType, StoredType >::setWritable ( Bool  isWritable)
inlineprotected

Set if the column is writable or not.

Definition at line 509 of file BaseMappedArrayEngine.h.

◆ shape()

template<class VirtualType , class StoredType >
virtual IPosition casacore::BaseMappedArrayEngine< VirtualType, StoredType >::shape ( rownr_t  rownr)
protectedvirtual

Get the shape of the (underlying) array in the given row.

This implementation assumes the shape of virtual and stored arrays are the same. If not, it has to be overidden in a derived class.

Reimplemented from casacore::VirtualArrayColumnBase.

Reimplemented in casacore::ScaledComplexData< VirtualType, StoredType >, and casacore::RetypedArrayEngine< VirtualType, StoredType >.

◆ storedName()

template<class VirtualType , class StoredType >
const String & casacore::BaseMappedArrayEngine< VirtualType, StoredType >::storedName
inline

Get the stored column name.

Definition at line 495 of file BaseMappedArrayEngine.h.

◆ virtualName()

template<class VirtualType , class StoredType >
const String & casacore::BaseMappedArrayEngine< VirtualType, StoredType >::virtualName
inline

Get the virtual column name.

Definition at line 490 of file BaseMappedArrayEngine.h.

Member Data Documentation

◆ arrayIsFixed_p

template<class VirtualType , class StoredType >
Bool casacore::BaseMappedArrayEngine< VirtualType, StoredType >::arrayIsFixed_p
private

Definition at line 481 of file BaseMappedArrayEngine.h.

◆ column_p

template<class VirtualType , class StoredType >
ArrayColumn<StoredType>* casacore::BaseMappedArrayEngine< VirtualType, StoredType >::column_p
private

Definition at line 483 of file BaseMappedArrayEngine.h.

◆ initialNrrow_p

template<class VirtualType , class StoredType >
rownr_t casacore::BaseMappedArrayEngine< VirtualType, StoredType >::initialNrrow_p
private

Definition at line 480 of file BaseMappedArrayEngine.h.

◆ isWritable_p

template<class VirtualType , class StoredType >
Bool casacore::BaseMappedArrayEngine< VirtualType, StoredType >::isWritable_p
private

Definition at line 476 of file BaseMappedArrayEngine.h.

◆ shapeFixed_p

template<class VirtualType , class StoredType >
IPosition casacore::BaseMappedArrayEngine< VirtualType, StoredType >::shapeFixed_p
private

Definition at line 482 of file BaseMappedArrayEngine.h.

◆ storedName_p

template<class VirtualType , class StoredType >
String casacore::BaseMappedArrayEngine< VirtualType, StoredType >::storedName_p
private

Definition at line 475 of file BaseMappedArrayEngine.h.

◆ tempWritable_p

template<class VirtualType , class StoredType >
Bool casacore::BaseMappedArrayEngine< VirtualType, StoredType >::tempWritable_p
private

Definition at line 477 of file BaseMappedArrayEngine.h.

◆ virtualName_p

template<class VirtualType , class StoredType >
String casacore::BaseMappedArrayEngine< VirtualType, StoredType >::virtualName_p
private

Definition at line 474 of file BaseMappedArrayEngine.h.


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