casacore
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
casacore::VirtualArrayColumn< T > Class Template Referenceabstract

#include <VirtArrCol.h>

Public Member Functions

 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 ()
 
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 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 uInt ndim (rownr_t rownr)
 Get the dimensionality 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...
 
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 getArray (rownr_t rownr, Array< T > &data)=0
 Get the array value in the given row. More...
 
virtual void putArray (rownr_t rownr, const Array< T > &data)
 Put the array value into the given row. More...
 
virtual void getSlice (rownr_t rownr, const Slicer &slicer, Array< T > &data)
 Get a section of the array in the given row. More...
 
virtual void putSlice (rownr_t rownr, const Slicer &slicer, const Array< T > &data)
 Put into a section of the array in the given row. More...
 
virtual void getArrayColumn (Array< T > &data)
 Get an entire column. More...
 
virtual void putArrayColumn (const Array< T > &data)
 Put an entire column. More...
 
virtual void getArrayColumnCells (const RefRows &rownrs, Array< T > &data)
 Get some array values in the column. More...
 
virtual void putArrayColumnCells (const RefRows &rownrs, const Array< T > &data)
 Put some array values in the column. More...
 
virtual void getColumnSlice (const Slicer &slicer, Array< T > &data)
 Get a section of all arrays in the column. More...
 
virtual void putColumnSlice (const Slicer &slicer, const Array< T > &data)
 Put a section of all arrays in the column. More...
 
virtual void getColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, Array< T > &data)
 Get a section of some arrays in the column. More...
 
virtual void putColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, const Array< T > &data)
 Put into a section of some arrays in the column. More...
 
- Protected Member Functions inherited from casacore::VirtualArrayColumnBase
virtual void setShapeColumn (const IPosition &shape)
 Set the shape of all arrays in the column. More...
 
virtual void setShape (rownr_t rownr, const IPosition &shape)
 Set the shape of an array in the given row. More...
 
virtual Bool isShapeDefined (rownr_t rownr)
 Is the value shape defined in the given row? By default it throws a "not possible" exception. More...
 
virtual IPosition shape (rownr_t rownr)
 Get the shape of the item in the given row. More...
 
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

void getArrayV (rownr_t rownr, ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void putArrayV (rownr_t rownr, const ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void getArrayColumnCellsV (const RefRows &rownrs, ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void putArrayColumnCellsV (const RefRows &rownrs, const ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void getSliceV (rownr_t rownr, const Slicer &slicer, ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void putSliceV (rownr_t rownr, const Slicer &slicer, const ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void getArrayColumnV (ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void putArrayColumnV (const ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void getColumnSliceV (const Slicer &slicer, ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
void putColumnSliceV (const Slicer &slicer, const ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
virtual void getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
virtual void putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &dataPtr)
 Implement the virtual functions defined in DataManagerColumn. More...
 
 VirtualArrayColumn (const VirtualArrayColumn< T > &)
 The object cannot be copied. More...
 
VirtualArrayColumn< T > & operator= (const VirtualArrayColumn< T > &)
 The object cannot be assigned to. More...
 

Detailed Description

template<class T>
class casacore::VirtualArrayColumn< T >

Definition at line 179 of file VirtArrCol.h.

Constructor & Destructor Documentation

◆ VirtualArrayColumn() [1/2]

template<class T >
casacore::VirtualArrayColumn< T >::VirtualArrayColumn ( )
inline

Create a column.

Definition at line 183 of file VirtArrCol.h.

◆ ~VirtualArrayColumn()

template<class T >
virtual casacore::VirtualArrayColumn< T >::~VirtualArrayColumn ( )
virtual

◆ VirtualArrayColumn() [2/2]

template<class T >
casacore::VirtualArrayColumn< T >::VirtualArrayColumn ( const VirtualArrayColumn< T > &  )
private

The object cannot be copied.

Member Function Documentation

◆ dataType()

template<class T >
virtual int casacore::VirtualArrayColumn< T >::dataType ( ) const
virtual

Return the data type of the column.

Implements casacore::DataManagerColumn.

◆ dataTypeId()

template<class T >
virtual String casacore::VirtualArrayColumn< T >::dataTypeId ( ) const
virtual

Return the data type Id of the column.

Reimplemented from casacore::DataManagerColumn.

◆ getArray()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::getArray ( rownr_t  rownr,
Array< T > &  data 
)
protectedpure virtual

◆ getArrayColumn()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::getArrayColumn ( Array< T > &  data)
protectedvirtual

Get an entire column.

The data array has to have the correct shape (which is guaranteed by the ArrayColum::getColumn function). The default implementation gets the column row by row.

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

◆ getArrayColumnCells()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::getArrayColumnCells ( const RefRows rownrs,
Array< T > &  data 
)
protectedvirtual

Get some array values in the column.

The data array has to have the correct length (which is guaranteed by the ArrayColumn::getColumn function). By default it throws a "not possible" exception.

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

◆ getArrayColumnCellsV()

template<class T >
void casacore::VirtualArrayColumn< T >::getArrayColumnCellsV ( const RefRows rownrs,
ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get some array values in the column.

Reimplemented from casacore::DataManagerColumn.

◆ getArrayColumnV()

template<class T >
void casacore::VirtualArrayColumn< T >::getArrayColumnV ( ArrayBase dataPtr)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get an entire column.

Reimplemented from casacore::DataManagerColumn.

◆ getArrayV()

template<class T >
void casacore::VirtualArrayColumn< T >::getArrayV ( rownr_t  rownr,
ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get the array value in the given row.

Reimplemented from casacore::DataManagerColumn.

◆ getColumnSlice()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::getColumnSlice ( const Slicer slicer,
Array< T > &  data 
)
protectedvirtual

Get a section of all arrays in the column.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::getColumn function). The default implementation gets the column row by row.

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

◆ getColumnSliceCells()

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

Get a section of some arrays in the column.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::getColumn function). By default it throws a "not possible" exception.

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

◆ getColumnSliceCellsV()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::getColumnSliceCellsV ( const RefRows rownrs,
const Slicer slicer,
ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get a section of some arrays in the column.

Reimplemented from casacore::DataManagerColumn.

◆ getColumnSliceV()

template<class T >
void casacore::VirtualArrayColumn< T >::getColumnSliceV ( const Slicer slicer,
ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get a section of all arrays in the column.

Reimplemented from casacore::DataManagerColumn.

◆ getSlice()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::getSlice ( rownr_t  rownr,
const Slicer slicer,
Array< T > &  data 
)
protectedvirtual

Get a section of the array in the given row.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::getSlice function). The default implementation gets the slice by getting the full array first.

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

◆ getSliceV()

template<class T >
void casacore::VirtualArrayColumn< T >::getSliceV ( rownr_t  rownr,
const Slicer slicer,
ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get a section of the array in the given row.

Reimplemented from casacore::DataManagerColumn.

◆ operator=()

template<class T >
VirtualArrayColumn<T>& casacore::VirtualArrayColumn< T >::operator= ( const VirtualArrayColumn< T > &  )
private

The object cannot be assigned to.

◆ putArray()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::putArray ( rownr_t  rownr,
const Array< T > &  data 
)
protectedvirtual

Put the array value into the given row.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::put function). By default it throws a "not possible" exception.

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

◆ putArrayColumn()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::putArrayColumn ( const Array< T > &  data)
protectedvirtual

Put an entire column.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::putColumn function). The default implementation puts the column row by row.

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

◆ putArrayColumnCells()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::putArrayColumnCells ( const RefRows rownrs,
const Array< T > &  data 
)
protectedvirtual

Put some array values in the column.

The data array has to have the correct length (which is guaranteed by the ArrayColumn::putColumn function). By default it throws a "not possible" exception.

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

◆ putArrayColumnCellsV()

template<class T >
void casacore::VirtualArrayColumn< T >::putArrayColumnCellsV ( const RefRows rownrs,
const ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put some array values in the column.

Reimplemented from casacore::DataManagerColumn.

◆ putArrayColumnV()

template<class T >
void casacore::VirtualArrayColumn< T >::putArrayColumnV ( const ArrayBase dataPtr)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put an entire column.

Reimplemented from casacore::DataManagerColumn.

◆ putArrayV()

template<class T >
void casacore::VirtualArrayColumn< T >::putArrayV ( rownr_t  rownr,
const ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put the array value into the given row.

Reimplemented from casacore::DataManagerColumn.

◆ putColumnSlice()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::putColumnSlice ( const Slicer slicer,
const Array< T > &  data 
)
protectedvirtual

Put a section of all arrays in the column.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function). The default implementation puts the column row by row.

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

◆ putColumnSliceCells()

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

Put into a section of some arrays in the column.

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::putColumn function). By default it throws a "not possible" exception.

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

◆ putColumnSliceCellsV()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::putColumnSliceCellsV ( const RefRows rownrs,
const Slicer slicer,
const ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put into a section of some arrays in the column.

Reimplemented from casacore::DataManagerColumn.

◆ putColumnSliceV()

template<class T >
void casacore::VirtualArrayColumn< T >::putColumnSliceV ( const Slicer slicer,
const ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put into section of all arrays in the column.

Reimplemented from casacore::DataManagerColumn.

◆ putSlice()

template<class T >
virtual void casacore::VirtualArrayColumn< T >::putSlice ( rownr_t  rownr,
const Slicer slicer,
const Array< T > &  data 
)
protectedvirtual

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

The data array has to have the correct shape (which is guaranteed by the ArrayColumn::putSlice function). The default implementation gets the slice by accessing the full array.

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

◆ putSliceV()

template<class T >
void casacore::VirtualArrayColumn< T >::putSliceV ( rownr_t  rownr,
const Slicer slicer,
const ArrayBase dataPtr 
)
privatevirtual

Implement the virtual functions defined in DataManagerColumn.

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

Reimplemented from casacore::DataManagerColumn.


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