casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::ForwardColumnIndexedRow Class Reference

More...

#include <ForwardColRow.h>

Public Member Functions

 ForwardColumnIndexedRow (ForwardColumnIndexedRowEngine *enginePtr, const String &columnName, int dataType, const String &dataTypeId, const Table &referencedTable)
 Construct it for the given column. More...
 
 ~ForwardColumnIndexedRow ()
 Destructor is mandatory. More...
 
void prepare (const Table &thisTable)
 Initialize the object. More...
 
- Public Member Functions inherited from casacore::ForwardColumn
 ForwardColumn (ForwardColumnEngine *enginePtr, const String &columnName, int dataType, const String &dataTypeId, const Table &referencedTable)
 Construct it for the given column. More...
 
virtual ~ForwardColumn ()
 Destructor is mandatory. More...
 
void fillTableName (const Table &thisTable, const Table &referencedTable)
 Define the special keyword containing the name of the original table. More...
 
void setRW ()
 Set the column to writable if its underlying table is writable. 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 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...
 

Private Member Functions

 ForwardColumnIndexedRow (const ForwardColumnIndexedRow &)
 Copy constructor is not needed and therefore forbidden (so make it private). More...
 
ForwardColumnIndexedRowoperator= (const ForwardColumnIndexedRow &)
 Assignment is not needed and therefore forbidden (so make it private). More...
 
Bool canChangeShape () const
 This data manager cannot handle changing array shapes. More...
 
void setShape (rownr_t rownr, const IPosition &shape)
 Set the shape of an (indirect) array in the given row. More...
 
Bool isShapeDefined (rownr_t rownr)
 Is the value shape defined in the given row? More...
 
uInt ndim (rownr_t rownr)
 Get the dimensionality of the item in the given row. More...
 
IPosition shape (rownr_t rownr)
 Get the shape of the item in the given row. More...
 
virtual void getBool (rownr_t rownr, Bool *dataPtr)
 Get the scalar value with a standard data type 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)
 Get the scalar value with a non-standard data type in the given row. More...
 
virtual void putBool (rownr_t rownr, const Bool *dataPtr)
 Put the scalar value with a standard data type 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)
 Put the scalar value with a non-standard data type into the given row. More...
 
void getArrayV (rownr_t rownr, ArrayBase &dataPtr)
 Get the array value in the given row. More...
 
void putArrayV (rownr_t rownr, const ArrayBase &dataPtr)
 Put the array value into the given row. More...
 
void getSliceV (rownr_t rownr, const Slicer &slicer, ArrayBase &dataPtr)
 Get a section of the array in the given row. More...
 
void putSliceV (rownr_t rownr, const Slicer &slicer, const ArrayBase &dataPtr)
 Put into a section of the array in the given row. More...
 
rownr_t convertRownr (rownr_t rownr)
 Convert the rownr to the rownr in the underlying table. More...
 

Private Attributes

ForwardColumnIndexedRowEngineenginePtr_p
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::ForwardColumn
void basePrepare (const Table &thisTable, Bool writable)
 Do the preparation of the base class column object. More...
 
BaseColumncolPtr () const
 
- Protected Member Functions inherited from casacore::DataManagerColumn
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

Virtual column forwarding to another row/column

Review Status

Reviewed By:
Paul Shannon
Date Reviewed:
1995/05/22
Test programs:
tForwardColRow

Intended use:

Internal

Prerequisite

Etymology

ForwardColumnIndexedRow handles the forwarding of the gets and puts for an individual row/column on behalf of the virtual column engine ForwardColumnIndexedRowEngine. It forwards them to a row/column in another table. The row forwarding is done using a special column containing row numbers indexing the referenced table.

Synopsis

ForwardColumnIndexedRow represents a virtual column which forwards the gets and puts to a column with the same name in another table. It is, in fact, a reference to the other column. The row numbers in the column are mapped to row numbers in the referenced column using a special column containing the mapping. The name of the other table is stored as a keyword in the forwarding column. When the referenced column is in its turn a ForwardColumn (note: not a ForwardColumnIndexedRow), the table mentioned in there will be used. In this way, the length of the forwarding chain is kept to a minimum.

An object of this class is created (and deleted) by the virtual column engine

ForwardColumnIndexedRowEngine which creates a ForwardColumnIndexedRow object for each column being forwarded.

Definition at line 86 of file ForwardColRow.h.

Constructor & Destructor Documentation

◆ ForwardColumnIndexedRow() [1/2]

casacore::ForwardColumnIndexedRow::ForwardColumnIndexedRow ( ForwardColumnIndexedRowEngine enginePtr,
const String columnName,
int  dataType,
const String dataTypeId,
const Table referencedTable 
)

Construct it for the given column.

◆ ~ForwardColumnIndexedRow()

casacore::ForwardColumnIndexedRow::~ForwardColumnIndexedRow ( )

Destructor is mandatory.

◆ ForwardColumnIndexedRow() [2/2]

casacore::ForwardColumnIndexedRow::ForwardColumnIndexedRow ( const ForwardColumnIndexedRow )
private

Copy constructor is not needed and therefore forbidden (so make it private).

Member Function Documentation

◆ canChangeShape()

Bool casacore::ForwardColumnIndexedRow::canChangeShape ( ) const
privatevirtual

This data manager cannot handle changing array shapes.

Reimplemented from casacore::ForwardColumn.

◆ convertRownr()

rownr_t casacore::ForwardColumnIndexedRow::convertRownr ( rownr_t  rownr)
inlineprivate

Convert the rownr to the rownr in the underlying table.

Definition at line 400 of file ForwardColRow.h.

References casacore::ForwardColumnIndexedRowEngine::convertRownr(), and enginePtr_p.

◆ getArrayV()

void casacore::ForwardColumnIndexedRow::getArrayV ( rownr_t  rownr,
ArrayBase dataPtr 
)
privatevirtual

Get the array value in the given row.

The argument dataPtr is in fact a Array<T>&, but a ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn get function).

Reimplemented from casacore::ForwardColumn.

◆ getBool()

virtual void casacore::ForwardColumnIndexedRow::getBool ( rownr_t  rownr,
Bool dataPtr 
)
privatevirtual

Get the scalar value with a standard data type in the given row.

Reimplemented from casacore::ForwardColumn.

◆ getComplex()

virtual void casacore::ForwardColumnIndexedRow::getComplex ( rownr_t  rownr,
Complex *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getDComplex()

virtual void casacore::ForwardColumnIndexedRow::getDComplex ( rownr_t  rownr,
DComplex *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getdouble()

virtual void casacore::ForwardColumnIndexedRow::getdouble ( rownr_t  rownr,
double *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getfloat()

virtual void casacore::ForwardColumnIndexedRow::getfloat ( rownr_t  rownr,
float *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getInt()

virtual void casacore::ForwardColumnIndexedRow::getInt ( rownr_t  rownr,
Int dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getInt64()

virtual void casacore::ForwardColumnIndexedRow::getInt64 ( rownr_t  rownr,
Int64 dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getOther()

virtual void casacore::ForwardColumnIndexedRow::getOther ( rownr_t  rownr,
void *  dataPtr 
)
privatevirtual

Get the scalar value with a non-standard data type in the given row.

Reimplemented from casacore::ForwardColumn.

◆ getShort()

virtual void casacore::ForwardColumnIndexedRow::getShort ( rownr_t  rownr,
Short dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getSliceV()

void casacore::ForwardColumnIndexedRow::getSliceV ( rownr_t  rownr,
const Slicer slicer,
ArrayBase dataPtr 
)
privatevirtual

Get a section of the array in the given row.

The argument dataPtr is in fact a Array<T>&, but a ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getSlice function).

Reimplemented from casacore::ForwardColumn.

◆ getString()

virtual void casacore::ForwardColumnIndexedRow::getString ( rownr_t  rownr,
String dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getuChar()

virtual void casacore::ForwardColumnIndexedRow::getuChar ( rownr_t  rownr,
uChar dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getuInt()

virtual void casacore::ForwardColumnIndexedRow::getuInt ( rownr_t  rownr,
uInt dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ getuShort()

virtual void casacore::ForwardColumnIndexedRow::getuShort ( rownr_t  rownr,
uShort dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ isShapeDefined()

Bool casacore::ForwardColumnIndexedRow::isShapeDefined ( rownr_t  rownr)
privatevirtual

Is the value shape defined in the given row?

Reimplemented from casacore::ForwardColumn.

◆ ndim()

uInt casacore::ForwardColumnIndexedRow::ndim ( rownr_t  rownr)
privatevirtual

Get the dimensionality of the item in the given row.

Reimplemented from casacore::ForwardColumn.

◆ operator=()

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

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

◆ prepare()

void casacore::ForwardColumnIndexedRow::prepare ( const Table thisTable)
virtual

Initialize the object.

This means binding the column to the column with the same name in the original table. It checks if the description of both columns is the same.

Reimplemented from casacore::ForwardColumn.

◆ putArrayV()

void casacore::ForwardColumnIndexedRow::putArrayV ( rownr_t  rownr,
const ArrayBase dataPtr 
)
privatevirtual

Put the array value into the given row.

This throws an exception, because putting is not supported.

Reimplemented from casacore::ForwardColumn.

◆ putBool()

virtual void casacore::ForwardColumnIndexedRow::putBool ( rownr_t  rownr,
const Bool dataPtr 
)
privatevirtual

Put the scalar value with a standard data type into the given row.

This throws an exception, because putting is not supported.

Reimplemented from casacore::ForwardColumn.

◆ putComplex()

virtual void casacore::ForwardColumnIndexedRow::putComplex ( rownr_t  rownr,
const Complex *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putDComplex()

virtual void casacore::ForwardColumnIndexedRow::putDComplex ( rownr_t  rownr,
const DComplex *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putdouble()

virtual void casacore::ForwardColumnIndexedRow::putdouble ( rownr_t  rownr,
const double *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putfloat()

virtual void casacore::ForwardColumnIndexedRow::putfloat ( rownr_t  rownr,
const float *  dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putInt()

virtual void casacore::ForwardColumnIndexedRow::putInt ( rownr_t  rownr,
const Int dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putInt64()

virtual void casacore::ForwardColumnIndexedRow::putInt64 ( rownr_t  rownr,
const Int64 dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putOther()

virtual void casacore::ForwardColumnIndexedRow::putOther ( rownr_t  rownr,
const void *  dataPtr 
)
privatevirtual

Put the scalar value with a non-standard data type into the given row.

This throws an exception, because putting is not supported.

Reimplemented from casacore::ForwardColumn.

◆ putShort()

virtual void casacore::ForwardColumnIndexedRow::putShort ( rownr_t  rownr,
const Short dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putSliceV()

void casacore::ForwardColumnIndexedRow::putSliceV ( rownr_t  rownr,
const Slicer slicer,
const ArrayBase dataPtr 
)
privatevirtual

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

This throws an exception, because putting is not supported.

Reimplemented from casacore::ForwardColumn.

◆ putString()

virtual void casacore::ForwardColumnIndexedRow::putString ( rownr_t  rownr,
const String dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putuChar()

virtual void casacore::ForwardColumnIndexedRow::putuChar ( rownr_t  rownr,
const uChar dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putuInt()

virtual void casacore::ForwardColumnIndexedRow::putuInt ( rownr_t  rownr,
const uInt dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ putuShort()

virtual void casacore::ForwardColumnIndexedRow::putuShort ( rownr_t  rownr,
const uShort dataPtr 
)
privatevirtual

Reimplemented from casacore::ForwardColumn.

◆ setShape()

void casacore::ForwardColumnIndexedRow::setShape ( rownr_t  rownr,
const IPosition shape 
)
privatevirtual

Set the shape of an (indirect) array in the given row.

This throws an exception, because putting is not supported.

Reimplemented from casacore::ForwardColumn.

◆ shape()

IPosition casacore::ForwardColumnIndexedRow::shape ( rownr_t  rownr)
privatevirtual

Get the shape of the item in the given row.

Reimplemented from casacore::ForwardColumn.

Member Data Documentation

◆ enginePtr_p

ForwardColumnIndexedRowEngine* casacore::ForwardColumnIndexedRow::enginePtr_p
private

Definition at line 196 of file ForwardColRow.h.

Referenced by convertRownr().


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