casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::ScalarColumnData< T > Class Template Reference

More...

#include <ScaColData.h>

Public Member Functions

 ScalarColumnData (const ScalarColumnDesc< T > *, ColumnSet *)
 Construct a scalar column object from the given description in the given column set. More...
 
 ~ScalarColumnData ()
 
virtual void initialize (rownr_t startRownr, rownr_t endRownr)
 Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the column description. More...
 
virtual Bool isDefined (rownr_t rownr) const
 Test if the given cell contains a defined value. More...
 
virtual void get (rownr_t rownr, void *) const
 Get the value from a particular cell. More...
 
virtual void getScalarColumn (ArrayBase &dataPtr) const
 Get the array of all values in the column. More...
 
virtual void getScalarColumnCells (const RefRows &rownrs, ArrayBase &dataPtr) const
 Get the array of some values in the column (on behalf of RefColumn). More...
 
virtual void put (rownr_t rownr, const void *dataPtr)
 Put the value in a particular cell. More...
 
virtual void putScalarColumn (const ArrayBase &dataPtr)
 Put the array of all values in the column. More...
 
virtual void putScalarColumnCells (const RefRows &rownrs, const ArrayBase &dataPtr)
 Put the array of some values in the column (on behalf on RefColumn). More...
 
virtual void makeSortKey (Sort &, CountedPtr< BaseCompare > &cmpFunc, Int order, CountedPtr< ArrayBase > &dataSave)
 Add the sort key to the Sort object on behalf of the Table sort function. More...
 
void makeRefSortKey (Sort &, CountedPtr< BaseCompare > &cmpFunc, Int order, const Vector< rownr_t > &rownrs, CountedPtr< ArrayBase > &dataSave)
 Do it only for the given row numbers. More...
 
void allocIterBuf (void *&lastVal, void *&curVal, CountedPtr< BaseCompare > &cmpObj)
 Allocate value buffers for the table iterator. More...
 
void freeIterBuf (void *&lastVal, void *&curVal)
 Free the value buffers allocated by allocIterBuf. More...
 
void createDataManagerColumn ()
 Create a data manager column object for this column. More...
 
- Public Member Functions inherited from casacore::PlainColumn
 PlainColumn (const BaseColumnDesc *, ColumnSet *)
 
virtual ~PlainColumn ()
 
virtual Bool isWritable () const
 Test if the column is in principle writable. More...
 
virtual Bool isStored () const
 Test if the column is stored (otherwise it is virtual). More...
 
TableRecordrwKeywordSet ()
 Get access to the column keyword set. More...
 
TableRecordkeywordSet ()
 
rownr_t nrow () const
 Get nr of rows in the column. More...
 
virtual void setShapeColumn (const IPosition &shape)
 Define the shape of all arrays in the column. More...
 
virtual Bool isBound () const
 Test if the column is bound to a storage manager or virtual column engine. More...
 
virtual void bind (DataManager *)
 Bind the column to a data manager. More...
 
DataManagerdataManager () const
 Get the pointer to the data manager. More...
 
DataManagerColumn *& dataManagerColumn ()
 Get the pointer to the data manager column. More...
 
virtual ColumnCachecolumnCache ()
 Get a pointer to the underlying column cache. More...
 
virtual void setMaximumCacheSize (uInt nbytes)
 Set the maximum cache size (in bytes) to be used by a storage manager. More...
 
void putFile (AipsIO &, const TableAttr &)
 Write the column. More...
 
void getFile (AipsIO &, const ColumnSet &, const TableAttr &)
 Read the column. More...
 
- Public Member Functions inherited from casacore::BaseColumn
 BaseColumn (const BaseColumnDesc *)
 Construct it using the given column description. More...
 
virtual ~BaseColumn ()
 
const ColumnDesccolumnDesc () const
 Get const access to the column description. More...
 
virtual void setShape (rownr_t rownr, const IPosition &shape)
 Set the shape of the array in the given row. More...
 
virtual void setShape (rownr_t rownr, const IPosition &shape, const IPosition &tileShape)
 Set the shape and tile shape of the array in the given row. More...
 
virtual uInt ndimColumn () const
 Get the global #dimensions of an array (ie. More...
 
virtual IPosition shapeColumn () const
 Get the global shape of an array (ie. More...
 
virtual uInt ndim (rownr_t rownr) const
 Get the #dimensions of an array in a particular cell. More...
 
virtual IPosition shape (rownr_t rownr) const
 Get the shape of an array in a particular cell. More...
 
virtual IPosition tileShape (rownr_t rownr) const
 Get the tile shape of an array in a particular cell. More...
 
virtual Bool canChangeShape () const
 Ask the data manager if the shape of an existing array can be changed. More...
 
virtual void getArray (rownr_t rownr, ArrayBase &dataPtr) const
 Get an array from a particular cell. More...
 
virtual void getSlice (rownr_t rownr, const Slicer &, ArrayBase &dataPtr) const
 Get a slice of an N-dimensional array in a particular cell. More...
 
virtual void getArrayColumn (ArrayBase &dataPtr) const
 Get the array of all array values in a column. More...
 
virtual void getColumnSlice (const Slicer &, ArrayBase &dataPtr) const
 Get subsections from all arrays in the column. More...
 
virtual void getArrayColumnCells (const RefRows &rownrs, ArrayBase &dataPtr) const
 Get the array of some array values in a column. More...
 
virtual void getColumnSliceCells (const RefRows &rownrs, const Slicer &, ArrayBase &dataPtr) const
 Get subsections from some arrays in the column. More...
 
virtual void putArray (rownr_t rownr, const ArrayBase &dataPtr)
 Put the array value in a particular cell. More...
 
virtual void putSlice (rownr_t rownr, const Slicer &, const ArrayBase &dataPtr)
 Put a slice of an N-dimensional array in a particular cell. More...
 
virtual void putArrayColumn (const ArrayBase &dataPtr)
 Put the array of all array values in the column. More...
 
virtual void putColumnSlice (const Slicer &, const ArrayBase &dataPtr)
 Put into subsections of all table arrays in the column. More...
 
virtual void putArrayColumnCells (const RefRows &rownrs, const ArrayBase &dataPtr)
 Get the array of some array values in a column. More...
 
virtual void putColumnSliceCells (const RefRows &rownrs, const Slicer &, const ArrayBase &dataPtr)
 Put subsections of some arrays in the column. More...
 
void getScalar (rownr_t rownr, Bool &value) const
 Get the value from the row and convert it to the required type. More...
 
void getScalar (rownr_t rownr, uChar &value) const
 
void getScalar (rownr_t rownr, Short &value) const
 
void getScalar (rownr_t rownr, uShort &value) const
 
void getScalar (rownr_t rownr, Int &value) const
 
void getScalar (rownr_t rownr, uInt &value) const
 
void getScalar (rownr_t rownr, Int64 &value) const
 
void getScalar (rownr_t rownr, float &value) const
 
void getScalar (rownr_t rownr, double &value) const
 
void getScalar (rownr_t rownr, Complex &value) const
 
void getScalar (rownr_t rownr, DComplex &value) const
 
void getScalar (rownr_t rownr, String &value) const
 
void getScalar (rownr_t rownr, TableRecord &value) const
 
void getScalar (rownr_t rownr, void *value, const String &dataTypeId) const
 Get a scalar for the other data types. More...
 
void putScalar (rownr_t rownr, const Bool &value)
 Put the value into the row and convert it from the given type. More...
 
void putScalar (rownr_t rownr, const uChar &value)
 
void putScalar (rownr_t rownr, const Short &value)
 
void putScalar (rownr_t rownr, const uShort &value)
 
void putScalar (rownr_t rownr, const Int &value)
 
void putScalar (rownr_t rownr, const uInt &value)
 
void putScalar (rownr_t rownr, const Int64 &value)
 
void putScalar (rownr_t rownr, const float &value)
 
void putScalar (rownr_t rownr, const double &value)
 
void putScalar (rownr_t rownr, const Complex &value)
 
void putScalar (rownr_t rownr, const DComplex &value)
 
void putScalar (rownr_t rownr, const String &value)
 
void putScalar (rownr_t rownr, const Char *value)
 
void putScalar (rownr_t rownr, const TableRecord &value)
 

Private Member Functions

 ScalarColumnData (const ScalarColumnData< T > &)
 Copy constructor cannot be used. More...
 
ScalarColumnData< T > & operator= (const ScalarColumnData< T > &)
 Assignment cannot be used. More...
 
void putFileDerived (AipsIO &)
 Write the column data. More...
 
void getFileDerived (AipsIO &, const ColumnSet &)
 Read the column data back. More...
 
void fillSortKey (const Vector< T > *dataPtr, Sort &, CountedPtr< BaseCompare > &cmpObj, Int order)
 Fill in the sort key on behalf of the Table sort function. More...
 

Private Attributes

const ScalarColumnDesc< T > * scaDescPtr_p
 Pointer to column description. More...
 
Bool undefFlag_p
 Undefined value can exist? More...
 
undefVal_p
 Undefined value. More...
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::PlainColumn
int traceId () const
 Get the trace-id of the table. More...
 
void checkValueLength (const void *) const
 Check the length of a value. More...
 
void checkValueLength (const String *value) const
 
void checkValueLength (const Array< String > *value) const
 
void checkReadLock (Bool wait) const
 Lock the table before reading or writing. More...
 
void checkWriteLock (Bool wait) const
 
void autoReleaseLock () const
 Inspect the auto lock when the inspection interval has expired and release it when another process needs the lock. More...
 
- Protected Member Functions inherited from casacore::BaseColumn
void throwGetScalar () const
 Throw exceptions for invalid scalar get or put. More...
 
void throwPutScalar () const
 
void throwGetType (const String &type) const
 
void throwPutType (const String &type) const
 
- Protected Attributes inherited from casacore::PlainColumn
DataManagerdataManPtr_p
 
DataManagerColumndataColPtr_p
 
ColumnSetcolSetPtr_p
 
String originalName_p
 
Bool rtraceColumn_p
 
Bool wtraceColumn_p
 
- Protected Attributes inherited from casacore::BaseColumn
const BaseColumnDesccolDescPtr_p
 

Detailed Description

template<class T>
class casacore::ScalarColumnData< T >

Access to a table column containing scalars

Intended use:

Internal

Review Status

Reviewed By:
Gareth Hunt
Date Reviewed:
94Nov17

Prerequisite

Etymology

ScalarColumnData represents a table column containing scalars.

Synopsis

The class ScalarColumnData is derived from PlainColumn. It implements the virtual functions accessing a table column containing scalars with an arbitrary data type.

It is possible to access an scalar an individual cell (i.e. table row) or in the entire column.

The main task of this class is to communicate with the data manager column object. This consists of:

The class is hidden from the user by the envelope class ScalarColumn. It used directly, it should be done with care. It assumes that the arrays in the various get and put functions have the correct length. ScalarColumn does that check.

Definition at line 94 of file ScaColData.h.

Constructor & Destructor Documentation

◆ ScalarColumnData() [1/2]

template<class T >
casacore::ScalarColumnData< T >::ScalarColumnData ( const ScalarColumnDesc< T > *  ,
ColumnSet  
)

Construct a scalar column object from the given description in the given column set.

This constructor is used by ScalarColumnDesc::makeColumn.

◆ ~ScalarColumnData()

template<class T >
casacore::ScalarColumnData< T >::~ScalarColumnData ( )

◆ ScalarColumnData() [2/2]

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

Copy constructor cannot be used.

Member Function Documentation

◆ allocIterBuf()

template<class T >
void casacore::ScalarColumnData< T >::allocIterBuf ( void *&  lastVal,
void *&  curVal,
CountedPtr< BaseCompare > &  cmpObj 
)
virtual

Allocate value buffers for the table iterator.

Also get a comparison object if undefined. The function freeIterBuf must be called to free the buffers.

Reimplemented from casacore::BaseColumn.

◆ createDataManagerColumn()

template<class T >
void casacore::ScalarColumnData< T >::createDataManagerColumn ( )
virtual

Create a data manager column object for this column.

Implements casacore::PlainColumn.

◆ fillSortKey()

template<class T >
void casacore::ScalarColumnData< T >::fillSortKey ( const Vector< T > *  dataPtr,
Sort ,
CountedPtr< BaseCompare > &  cmpObj,
Int  order 
)
private

Fill in the sort key on behalf of the Table sort function.

The pointer to the data (which can be allocated on the heap) is stored in dataPtr. This is used by freeSortKey to release it. It checks if a compare function is given when needed.

Thrown Exceptions

◆ freeIterBuf()

template<class T >
void casacore::ScalarColumnData< T >::freeIterBuf ( void *&  lastVal,
void *&  curVal 
)
virtual

Free the value buffers allocated by allocIterBuf.

Reimplemented from casacore::BaseColumn.

◆ get()

template<class T >
virtual void casacore::ScalarColumnData< T >::get ( rownr_t  rownr,
void *   
) const
virtual

Get the value from a particular cell.

Reimplemented from casacore::BaseColumn.

◆ getFileDerived()

template<class T >
void casacore::ScalarColumnData< T >::getFileDerived ( AipsIO ,
const ColumnSet  
)
privatevirtual

Read the column data back.

The control information is read from the given AipsIO object. This is used to bind the column to the appropriate data manager. Thereafter the data manager gets opened.

Implements casacore::PlainColumn.

◆ getScalarColumn()

template<class T >
virtual void casacore::ScalarColumnData< T >::getScalarColumn ( ArrayBase dataPtr) const
virtual

Get the array of all values in the column.

The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.

Reimplemented from casacore::BaseColumn.

◆ getScalarColumnCells()

template<class T >
virtual void casacore::ScalarColumnData< T >::getScalarColumnCells ( const RefRows rownrs,
ArrayBase dataPtr 
) const
virtual

Get the array of some values in the column (on behalf of RefColumn).

The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.

Reimplemented from casacore::BaseColumn.

◆ initialize()

template<class T >
virtual void casacore::ScalarColumnData< T >::initialize ( rownr_t  startRownr,
rownr_t  endRownr 
)
virtual

Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the column description.

Implements casacore::BaseColumn.

◆ isDefined()

template<class T >
virtual Bool casacore::ScalarColumnData< T >::isDefined ( rownr_t  rownr) const
virtual

Test if the given cell contains a defined value.

Implements casacore::BaseColumn.

◆ makeRefSortKey()

template<class T >
void casacore::ScalarColumnData< T >::makeRefSortKey ( Sort ,
CountedPtr< BaseCompare > &  cmpFunc,
Int  order,
const Vector< rownr_t > &  rownrs,
CountedPtr< ArrayBase > &  dataSave 
)
virtual

Do it only for the given row numbers.

Reimplemented from casacore::BaseColumn.

◆ makeSortKey()

template<class T >
virtual void casacore::ScalarColumnData< T >::makeSortKey ( Sort ,
CountedPtr< BaseCompare > &  cmpFunc,
Int  order,
CountedPtr< ArrayBase > &  dataSave 
)
virtual

Add the sort key to the Sort object on behalf of the Table sort function.

Reimplemented from casacore::BaseColumn.

◆ operator=()

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

Assignment cannot be used.

◆ put()

template<class T >
virtual void casacore::ScalarColumnData< T >::put ( rownr_t  rownr,
const void *  dataPtr 
)
virtual

Put the value in a particular cell.

The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.

Reimplemented from casacore::BaseColumn.

◆ putFileDerived()

template<class T >
void casacore::ScalarColumnData< T >::putFileDerived ( AipsIO )
privatevirtual

Write the column data.

The control information is written into the given AipsIO object, while the data is written/flushed by the data manager.

Implements casacore::PlainColumn.

◆ putScalarColumn()

template<class T >
virtual void casacore::ScalarColumnData< T >::putScalarColumn ( const ArrayBase dataPtr)
virtual

Put the array of all values in the column.

The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.

Reimplemented from casacore::BaseColumn.

◆ putScalarColumnCells()

template<class T >
virtual void casacore::ScalarColumnData< T >::putScalarColumnCells ( const RefRows rownrs,
const ArrayBase dataPtr 
)
virtual

Put the array of some values in the column (on behalf on RefColumn).

The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.

Reimplemented from casacore::BaseColumn.

Member Data Documentation

◆ scaDescPtr_p

template<class T >
const ScalarColumnDesc<T>* casacore::ScalarColumnData< T >::scaDescPtr_p
private

Pointer to column description.

Definition at line 167 of file ScaColData.h.

◆ undefFlag_p

template<class T >
Bool casacore::ScalarColumnData< T >::undefFlag_p
private

Undefined value can exist?

Definition at line 169 of file ScaColData.h.

◆ undefVal_p

template<class T >
T casacore::ScalarColumnData< T >::undefVal_p
private

Undefined value.

Definition at line 171 of file ScaColData.h.


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