Loading...
Searching...
No Matches
ConcatColumn.h
Go to the documentation of this file.
//# ConcatColumn.h: A column in a concatenated table
//# Copyright (C) 2008
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef TABLES_CONCATCOLUMN_H
#define TABLES_CONCATCOLUMN_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/Tables/BaseColumn.h>
#include <casacore/tables/Tables/ColumnCache.h>
#include <casacore/tables/Tables/TableRecord.h>
#include <casacore/casa/Arrays/ArrayFwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class ConcatTable;
class BaseColumnDesc;
class TableRecord;
class Slicer;
class IPosition;
// <summary>
// A column in a concatenated table
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> ConcatTable
// <li> BaseColumn
// </prerequisite>
// <etymology>
// ConcatTable represents a column in a ConcatTable. A ConcatTable is a table
// referencing another table, usually as the result of a select, etc..
// </etymology>
// <synopsis>
// ConcatColumn handles the access of a column in a ConcatTable.
// It calls the corresponding function in the referenced column
// while converting the given row number to the row number in the
// referenced table.
// </synopsis>
// <motivation>
// This class is untyped, i.e. not templated.
// Every call is sent to the underlying referenced BaseColumn which
// is typed by the virtual function mechanism.
// A ConcatColumn can never be used directly. A user always has to
// construct a typed ArrayColumn or ScalarColumn object to access a column.
// This means everyting is fully type safe.
// </motivation>
// <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
// <li> Act upon removal of rows or the underlying column
// </todo>
class ConcatColumn : public BaseColumn
{
public:
// Construct the ConcatColumn. It will point to the given column
// description, ConcatTable and referenced column.
// The ConcatTable will be used to convert the rownr to the rownr
// in the referenced column.
ConcatColumn (const BaseColumnDesc*, ConcatTable*);
~ConcatColumn();
// Test if the column is writable in the parent table.
virtual Bool isWritable() const;
// Test if the column is stored (otherwise it is virtual).
virtual Bool isStored() const;
// Get access to the column keyword set.
// The initial keyword set is a copy of the keyword set of the first table.
// <group>
virtual TableRecord& rwKeywordSet();
virtual TableRecord& keywordSet();
// </group>
// Get nr of rows in the column.
virtual rownr_t nrow() const;
// Test if a value in a particular cell has been defined.
virtual Bool isDefined (rownr_t rownr) const;
// Set the shape of the array in the given row.
virtual void setShape (rownr_t rownr, const IPosition& shape);
// Set the shape and tile shape of the array in the given row.
virtual void setShape (rownr_t rownr, const IPosition& shape,
const IPosition& tileShape);
// Get the global #dimensions of an array (i.e. for all rows).
virtual uInt ndimColumn() const;
// Get the global shape of an array (i.e. for all rows).
virtual IPosition shapeColumn() const;
// Get the #dimensions of an array in a particular cell.
virtual uInt ndim (rownr_t rownr) const;
// Get the shape of an array in a particular cell.
virtual IPosition shape (rownr_t rownr) const;
// Get the tile shape of an array in a particular cell.
virtual IPosition tileShape (rownr_t rownr) const;
// It can change shape if the underlying column can.
virtual Bool canChangeShape() const;
// Initialize the rows from startRownr till endRownr (inclusive)
// with the default value defined in the column description (if defined).
virtual void initialize (rownr_t startRownr, rownr_t endRownr);
// Get a value from a particular cell.
virtual void get (rownr_t rownr, void* dataPtr) const;
// Get a slice of an N-dimensional array in a particular cell.
virtual void getSlice (rownr_t rownr, const Slicer&, ArrayBase& dataPtr) const;
// Get the array of all array values in a column.
// If the column contains n-dim arrays, the resulting array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void getArrayColumn (ArrayBase& dataPtr) const;
// Get subsections from all arrays in the column.
// If the column contains n-dim arrays, the resulting array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void getColumnSlice (const Slicer&, ArrayBase& dataPtr) const;
// Get an array from a particular cell.
virtual void getArray (rownr_t rownr, ArrayBase& dataPtr) const;
// Get the array of some array values in a column.
// If the column contains n-dim arrays, the resulting array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void getArrayColumnCells (const RefRows& rownrs,
ArrayBase& dataPtr) const;
// Get subsections from some arrays in the column.
// If the column contains n-dim arrays, the resulting array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void getColumnSliceCells (const RefRows& rownrs,
const Slicer&, ArrayBase& dataPtr) const;
// Put the scalar value in a particular cell.
virtual void put (rownr_t rownr, const void* dataPtr);
// Put the array value in a particular cell.
virtual void putArray (rownr_t rownr, const ArrayBase& dataPtr);
// Put a slice of an N-dimensional array in a particular cell.
virtual void putSlice (rownr_t rownr, const Slicer&, const ArrayBase& dataPtr);
// Put the array of all array values in the column.
// If the column contains n-dim arrays, the source array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void putArrayColumn (const ArrayBase& dataPtr);
// Put into subsections of all table arrays in the column.
// If the column contains n-dim arrays, the source array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void putColumnSlice (const Slicer&, const ArrayBase& dataPtr);
// Get the array of some array values in a column.
// If the column contains n-dim arrays, the resulting array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void putArrayColumnCells (const RefRows& rownrs,
const ArrayBase& dataPtr);
// Put subsections of some arrays in the column.
// If the column contains n-dim arrays, the source array is (n+1)-dim.
// The arrays in the column have to have the same shape in all cells.
virtual void putColumnSliceCells (const RefRows& rownrs,
const Slicer&, const ArrayBase& dataPtr);
// Get the underlying column cache.
virtual ColumnCache& columnCache();
// Set the maximum cache size (in bytes) to be used by a storage manager.
virtual void setMaximumCacheSize (uInt nbytes);
// Allocate value buffers for the table iterator.
// Also get a comparison function if undefined.
// The function freeIterBuf must be called to free the buffers.
virtual void allocIterBuf (void*& lastVal, void*& curVal,
std::shared_ptr<BaseCompare>& cmpObj);
// Free the value buffers allocated by allocIterBuf.
virtual void freeIterBuf (void*& lastVal, void*& curVal);
private:
// Define the function to handle access to an entire column.
typedef void AccessColumnFunc (BaseColumn* col,
const Slicer*, ArrayBase& array);
// Define the function to handle access to a number of rows.
typedef void AccessRowsFunc (BaseColumn* col, const RefRows& rows,
const Slicer*, ArrayBase& array);
// Access the data for an entire column.
void accessColumn (const Slicer* ns,
ArrayBase& dataPtr,
AccessColumnFunc*) const;
// Access the data with multiple rows combined.
void accessRows (const RefRows& rownrs,
const Slicer* ns,
ArrayBase& dataPtr,
AccessRowsFunc*) const;
// Define the access functions.
static void getColumnPart (BaseColumn* col,
const Slicer*, ArrayBase& arr);
static void putColumnPart (BaseColumn* col,
const Slicer*, ArrayBase& arr);
static void getColumnSlicePart (BaseColumn* col,
const Slicer* ns, ArrayBase& arr);
static void putColumnSlicePart (BaseColumn* col,
const Slicer* ns, ArrayBase& arr);
static void getRowsPart (BaseColumn* col, const RefRows& rows,
const Slicer*, ArrayBase& array);
static void putRowsPart (BaseColumn* col, const RefRows& rows,
const Slicer*, ArrayBase& array);
static void getRowsSlicePart (BaseColumn* col, const RefRows& rows,
const Slicer*, ArrayBase& array);
static void putRowsSlicePart (BaseColumn* col, const RefRows& rows,
const Slicer*, ArrayBase& array);
// </group>
protected:
// Set the column cache to the cache of the given table.
// The row numbers will be adjusted as needed.
void setColumnCache (uInt tableNr, const ColumnCache&) const;
//# Data members
ConcatTable* refTabPtr_p;
Block<BaseColumn*> refColPtr_p;
mutable ColumnCache colCache_p;
TableRecord keywordSet_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::ArrayBase
Non-templated base class for templated Array class.
Definition ArrayBase.h:71
casacore::BaseColumnDesc
Definition BaseColDesc.h:106
casacore::BaseColumn::BaseColumn
BaseColumn(const BaseColumnDesc *)
Construct it using the given column description.
casacore::Block
simple 1-D array
Definition Block.h:198
casacore::ColumnCache
Definition ColumnCache.h:85
casacore::ConcatColumn::putArrayColumnCells
virtual void putArrayColumnCells(const RefRows &rownrs, const ArrayBase &dataPtr)
Get the array of some array values in a column.
casacore::ConcatColumn::putColumnSliceCells
virtual void putColumnSliceCells(const RefRows &rownrs, const Slicer &, const ArrayBase &dataPtr)
Put subsections of some arrays in the column.
casacore::ConcatColumn::putColumnSlicePart
static void putColumnSlicePart(BaseColumn *col, const Slicer *ns, ArrayBase &arr)
casacore::ConcatColumn::putColumnPart
static void putColumnPart(BaseColumn *col, const Slicer *, ArrayBase &arr)
casacore::ConcatColumn::allocIterBuf
virtual void allocIterBuf(void *&lastVal, void *&curVal, std::shared_ptr< BaseCompare > &cmpObj)
Allocate value buffers for the table iterator.
casacore::ConcatColumn::tileShape
virtual IPosition tileShape(rownr_t rownr) const
Get the tile shape of an array in a particular cell.
casacore::ConcatColumn::freeIterBuf
virtual void freeIterBuf(void *&lastVal, void *&curVal)
Free the value buffers allocated by allocIterBuf.
casacore::ConcatColumn::ConcatColumn
ConcatColumn(const BaseColumnDesc *, ConcatTable *)
Construct the ConcatColumn.
casacore::ConcatColumn::get
virtual void get(rownr_t rownr, void *dataPtr) const
Get a value from a particular cell.
casacore::ConcatColumn::accessRows
void accessRows(const RefRows &rownrs, const Slicer *ns, ArrayBase &dataPtr, AccessRowsFunc *) const
Access the data with multiple rows combined.
casacore::ConcatColumn::isDefined
virtual Bool isDefined(rownr_t rownr) const
Test if a value in a particular cell has been defined.
casacore::ConcatColumn::getRowsSlicePart
static void getRowsSlicePart(BaseColumn *col, const RefRows &rows, const Slicer *, ArrayBase &array)
casacore::ConcatColumn::getColumnPart
static void getColumnPart(BaseColumn *col, const Slicer *, ArrayBase &arr)
Define the access functions.
casacore::ConcatColumn::putArray
virtual void putArray(rownr_t rownr, const ArrayBase &dataPtr)
Put the array value in a particular cell.
casacore::ConcatColumn::getArrayColumn
virtual void getArrayColumn(ArrayBase &dataPtr) const
Get the array of all array values in a column.
casacore::ConcatColumn::putArrayColumn
virtual void putArrayColumn(const ArrayBase &dataPtr)
Put the array of all array values in the column.
casacore::ConcatColumn::ndim
virtual uInt ndim(rownr_t rownr) const
Get the #dimensions of an array in a particular cell.
casacore::ConcatColumn::shape
virtual IPosition shape(rownr_t rownr) const
Get the shape of an array in a particular cell.
casacore::ConcatColumn::initialize
virtual void initialize(rownr_t startRownr, rownr_t endRownr)
Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the c...
casacore::ConcatColumn::getColumnSlice
virtual void getColumnSlice(const Slicer &, ArrayBase &dataPtr) const
Get subsections from all arrays in the column.
casacore::ConcatColumn::AccessColumnFunc
void AccessColumnFunc(BaseColumn *col, const Slicer *, ArrayBase &array)
Define the function to handle access to an entire column.
Definition ConcatColumn.h:226
casacore::ConcatColumn::~ConcatColumn
~ConcatColumn()
casacore::ConcatColumn::getArray
virtual void getArray(rownr_t rownr, ArrayBase &dataPtr) const
Get an array from a particular cell.
casacore::ConcatColumn::putColumnSlice
virtual void putColumnSlice(const Slicer &, const ArrayBase &dataPtr)
Put into subsections of all table arrays in the column.
casacore::ConcatColumn::setMaximumCacheSize
virtual void setMaximumCacheSize(uInt nbytes)
Set the maximum cache size (in bytes) to be used by a storage manager.
casacore::ConcatColumn::getColumnSlicePart
static void getColumnSlicePart(BaseColumn *col, const Slicer *ns, ArrayBase &arr)
casacore::ConcatColumn::putSlice
virtual void putSlice(rownr_t rownr, const Slicer &, const ArrayBase &dataPtr)
Put a slice of an N-dimensional array in a particular cell.
casacore::ConcatColumn::columnCache
virtual ColumnCache & columnCache()
Get the underlying column cache.
casacore::ConcatColumn::put
virtual void put(rownr_t rownr, const void *dataPtr)
Put the scalar value in a particular cell.
casacore::ConcatColumn::ndimColumn
virtual uInt ndimColumn() const
Get the global #dimensions of an array (i.e.
casacore::ConcatColumn::setShape
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.
casacore::ConcatColumn::getColumnSliceCells
virtual void getColumnSliceCells(const RefRows &rownrs, const Slicer &, ArrayBase &dataPtr) const
Get subsections from some arrays in the column.
casacore::ConcatColumn::getRowsPart
static void getRowsPart(BaseColumn *col, const RefRows &rows, const Slicer *, ArrayBase &array)
casacore::ConcatColumn::isStored
virtual Bool isStored() const
Test if the column is stored (otherwise it is virtual).
casacore::ConcatColumn::isWritable
virtual Bool isWritable() const
Test if the column is writable in the parent table.
casacore::ConcatColumn::putRowsPart
static void putRowsPart(BaseColumn *col, const RefRows &rows, const Slicer *, ArrayBase &array)
casacore::ConcatColumn::accessColumn
void accessColumn(const Slicer *ns, ArrayBase &dataPtr, AccessColumnFunc *) const
Access the data for an entire column.
casacore::ConcatColumn::shapeColumn
virtual IPosition shapeColumn() const
Get the global shape of an array (i.e.
casacore::ConcatColumn::getSlice
virtual void getSlice(rownr_t rownr, const Slicer &, ArrayBase &dataPtr) const
Get a slice of an N-dimensional array in a particular cell.
casacore::ConcatColumn::getArrayColumnCells
virtual void getArrayColumnCells(const RefRows &rownrs, ArrayBase &dataPtr) const
Get the array of some array values in a column.
casacore::ConcatColumn::putRowsSlicePart
static void putRowsSlicePart(BaseColumn *col, const RefRows &rows, const Slicer *, ArrayBase &array)
casacore::ConcatColumn::keywordSet
virtual TableRecord & keywordSet()
casacore::ConcatColumn::rwKeywordSet
virtual TableRecord & rwKeywordSet()
Get access to the column keyword set.
casacore::ConcatColumn::canChangeShape
virtual Bool canChangeShape() const
It can change shape if the underlying column can.
casacore::ConcatColumn::setShape
virtual void setShape(rownr_t rownr, const IPosition &shape)
Set the shape of the array in the given row.
casacore::ConcatColumn::nrow
virtual rownr_t nrow() const
Get nr of rows in the column.
casacore::ConcatColumn::AccessRowsFunc
void AccessRowsFunc(BaseColumn *col, const RefRows &rows, const Slicer *, ArrayBase &array)
Define the function to handle access to a number of rows.
Definition ConcatColumn.h:230
casacore::ConcatTable
Definition ConcatTable.h:117
casacore::IPosition
Definition IPosition.h:117
casacore::RefRows
Definition RefRows.h:84
casacore::Slicer
Definition Slicer.h:287
casacore::TableRecord
Definition TableRecord.h:183
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::array
TYPE * array
the allocated array
Definition hdu.h:491
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::refColPtr_p
Block< BaseColumn * > refColPtr_p
Definition ConcatColumn.h:270
casacore::setColumnCache
void setColumnCache(uInt tableNr, const ColumnCache &) const
Set the column cache to the cache of the given table.
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::keywordSet_p
TableRecord keywordSet_p
Definition ConcatColumn.h:272
casacore::refTabPtr_p
ConcatTable * refTabPtr_p
Definition ConcatColumn.h:269
casacore::rownr_t
uInt64 rownr_t
Define the type of a row number in a table.
Definition aipsxtype.h:44
casacore::colCache_p
ColumnCache colCache_p
Definition ConcatColumn.h:271