casacore
Public Member Functions | Protected Member Functions | List of all members
casacore::VirtualScalarColumnBase Class Reference

More...

#include <VirtScaCol.h>

Public Member Functions

 VirtualScalarColumnBase ()
 Create a column. More...
 
virtual ~VirtualScalarColumnBase ()
 
virtual Bool isWritable () const
 By default no data can be put in a virtual column. More...
 
- 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 int dataType () const =0
 Get the data type of the column as defined in DataType.h. More...
 
virtual String dataTypeId () const
 Get the data type id of the column for dataType==TpOther. 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 setShape (rownr_t rownr, const IPosition &shape)
 Set the shape of an (variable-shaped) array in the given row. 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 Bool isShapeDefined (rownr_t rownr)
 Is the value shape defined in the given row? By default it returns True. More...
 
virtual uInt ndim (rownr_t rownr)
 Get the dimensionality of the item in the given row. More...
 
virtual IPosition shape (rownr_t rownr)
 Get the shape of the item in the given row. More...
 
virtual IPosition tileShape (rownr_t rownr)
 Get the tile shape of the item in the given row. More...
 
virtual Bool canChangeShape () const
 Can the data manager handle chaging the shape of an existing array? Default is no. 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...
 
virtual void getScalarColumnV (ArrayBase &dataPtr)
 Get all scalar values in the column. 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...
 
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

virtual void getArrayV (rownr_t rownr, ArrayBase &dataPtr)
 The array access functions throw an exception. More...
 
virtual void putArrayV (rownr_t rownr, const ArrayBase &data)
 Put the array value into the given row. More...
 
virtual void getArrayColumnV (ArrayBase &data)
 Get all array values in the column. More...
 
virtual void putArrayColumnV (const ArrayBase &data)
 Put all array values in the column. More...
 
virtual void getArrayColumnCellsV (const RefRows &rownrs, ArrayBase &data)
 Get some array values in the column. More...
 
virtual void putArrayColumnCellsV (const RefRows &rownrs, const ArrayBase &data)
 Put some array values in the column. More...
 
virtual void getSliceV (rownr_t rownr, const Slicer &slicer, ArrayBase &data)
 Get a section of the array in the given row. More...
 
virtual void putSliceV (rownr_t rownr, const Slicer &slicer, const ArrayBase &data)
 Put into a section of the array in the given row. More...
 
virtual void getColumnSliceV (const Slicer &slicer, ArrayBase &data)
 Get a section of all arrays in the column. More...
 
virtual void putColumnSliceV (const Slicer &slicer, const ArrayBase &data)
 Put into a section of all arrays in the column. More...
 
virtual void getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, ArrayBase &data)
 Get a section of some arrays in the column. More...
 
virtual void putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &data)
 Put into a section of some arrays 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)
 

Detailed Description

Templated base class for virtual scalar column

Intended use:

Internal

Review Status

Reviewed By:
Gareth Hunt
Date Reviewed:
94Nov17

Prerequisite

Etymology

VirtualScalarColumn handles a virtual column containing a scalar.

Synopsis

VirtualScalarColumn is the abstract base class to handle a scalar column for a virtual column engine. It is derived from DataManagerColumn and reimplements some virtual functions to make life easier for the derived classes. It does the following:

Motivation

This class reimplements some virtual functions implemented by DataManagerColumn and types the data argument. In that way they are easier to implement in derived classes. Furthermore they allow default implementations.

Template Type Argument Requirements (T)

Definition at line 122 of file VirtScaCol.h.

Constructor & Destructor Documentation

◆ VirtualScalarColumnBase()

casacore::VirtualScalarColumnBase::VirtualScalarColumnBase ( )
inline

Create a column.

Definition at line 126 of file VirtScaCol.h.

◆ ~VirtualScalarColumnBase()

virtual casacore::VirtualScalarColumnBase::~VirtualScalarColumnBase ( )
virtual

Member Function Documentation

◆ getArrayColumnCellsV()

virtual void casacore::VirtualScalarColumnBase::getArrayColumnCellsV ( const RefRows rownrs,
ArrayBase data 
)
protectedvirtual

Get some array values in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function). The default implementation does a getArrayV per row.

Reimplemented from casacore::DataManagerColumn.

◆ getArrayColumnV()

virtual void casacore::VirtualScalarColumnBase::getArrayColumnV ( ArrayBase data)
protectedvirtual

Get all array values in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function). The default implementation does a getArrayV per row.

Reimplemented from casacore::DataManagerColumn.

◆ getArrayV()

virtual void casacore::VirtualScalarColumnBase::getArrayV ( rownr_t  rownr,
ArrayBase dataPtr 
)
protectedvirtual

The array access functions throw an exception.

Reimplemented from casacore::DataManagerColumn.

◆ getColumnSliceCellsV()

virtual void casacore::VirtualScalarColumnBase::getColumnSliceCellsV ( const RefRows rownrs,
const Slicer slicer,
ArrayBase data 
)
protectedvirtual

Get a section of some arrays in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function). The default implementation does a getSliceV per row.

Reimplemented from casacore::DataManagerColumn.

◆ getColumnSliceV()

virtual void casacore::VirtualScalarColumnBase::getColumnSliceV ( const Slicer slicer,
ArrayBase data 
)
protectedvirtual

Get a section of all arrays in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function). The default implementation does a getSliceV per row.

Reimplemented from casacore::DataManagerColumn.

◆ getSliceV()

virtual void casacore::VirtualScalarColumnBase::getSliceV ( rownr_t  rownr,
const Slicer slicer,
ArrayBase data 
)
protectedvirtual

Get a section of the array in the given row.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn getSlice function). The default implementation does getArrayV and takes the slice.

Reimplemented from casacore::DataManagerColumn.

◆ isWritable()

virtual Bool casacore::VirtualScalarColumnBase::isWritable ( ) const
virtual

By default no data can be put in a virtual column.

Reimplemented from casacore::DataManagerColumn.

Reimplemented in casacore::VSCEngine< T >.

◆ putArrayColumnCellsV()

virtual void casacore::VirtualScalarColumnBase::putArrayColumnCellsV ( const RefRows rownrs,
const ArrayBase data 
)
protectedvirtual

Put some array values in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function). The default implementation does a putArrayV per row.

Reimplemented from casacore::DataManagerColumn.

◆ putArrayColumnV()

virtual void casacore::VirtualScalarColumnBase::putArrayColumnV ( const ArrayBase data)
protectedvirtual

Put all array values in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function). The default implementation does a putArrayV per row.

Reimplemented from casacore::DataManagerColumn.

◆ putArrayV()

virtual void casacore::VirtualScalarColumnBase::putArrayV ( rownr_t  rownr,
const ArrayBase data 
)
protectedvirtual

Put the array value into the given row.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn put function). The default implementation throws an "invalid operation" exception.

Reimplemented from casacore::DataManagerColumn.

◆ putColumnSliceCellsV()

virtual void casacore::VirtualScalarColumnBase::putColumnSliceCellsV ( const RefRows rownrs,
const Slicer slicer,
const ArrayBase data 
)
protectedvirtual

Put into a section of some arrays in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function). The default implementation does a putSliceV per row.

Reimplemented from casacore::DataManagerColumn.

◆ putColumnSliceV()

virtual void casacore::VirtualScalarColumnBase::putColumnSliceV ( const Slicer slicer,
const ArrayBase data 
)
protectedvirtual

Put into a section of all arrays in the column.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function). The default implementation does a putSliceV per row.

Reimplemented from casacore::DataManagerColumn.

◆ putSliceV()

virtual void casacore::VirtualScalarColumnBase::putSliceV ( rownr_t  rownr,
const Slicer slicer,
const ArrayBase data 
)
protectedvirtual

Put into a section of the array in the given row.

The array given in data has to have the correct shape (which is guaranteed by the ArrayColumn putSlice function). The default implementation does get/putArrayV and puts the slice.

Reimplemented from casacore::DataManagerColumn.


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