Loading...
Searching...
No Matches
TSMCoordColumn.h
Go to the documentation of this file.
//# TSMCoordColumn.h: A coordinate column in Tiled Storage Manager
//# Copyright (C) 1995,1996,1999
//# 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_TSMCOORDCOLUMN_H
#define TABLES_TSMCOORDCOLUMN_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/TSMColumn.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary>
// A coordinate column in Tiled Storage Manager
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> <linkto class=TSMColumn>TSMColumn</linkto>
// <li> <linkto class=TSMCube>TSMCube</linkto>
// <li> <linkto class=Record>Record</linkto>
// </prerequisite>
// <etymology>
// TSMCoordColumn handles a coordinate column for a Tiled
// Storage Manager.
// </etymology>
// <synopsis>
// TSMCoordColumn is used by
// <linkto class=TiledStMan>TiledStMan</linkto>
// to handle the access to
// a table column containing coordinates of a tiled hypercube axis.
// There are 2 types of coordinates (as described at
// <linkto class=TableDesc:defineHypercolumn>
// TableDesc::defineHypercolumn</linkto>):
// <ol>
// <li> As a vector. These are the coordinates of the arrays held
// in the data cells. They are accessed via the get/putArray
// functions. Their shapes are dependent on the hypercube shape,
// so it is checked if they match.
// <li> As a scalar. These are the coordinates of the extra axes
// defined in the hypercube. They are accessed via the get/put
// functions.
// </ol>
// The coordinates are held in a TSMCube object. The row number
// determines which TSMCube object has to be accessed.
// <p>
// The creation of a TSMCoordColumn object is done by a TSMColumn object.
// This process is described in more detail in the class
// <linkto class=TSMColumn>TSMColumn</linkto>.
// </synopsis>
// <motivation>
// Handling coordinate columns in the Tiled Storage Manager is
// different from other columns.
// </motivation>
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class TSMCoordColumn : public TSMColumn
{
public:
// Create a coordinate column from the given column.
TSMCoordColumn (const TSMColumn& column, uInt axisNr);
// Frees up the storage.
virtual ~TSMCoordColumn();
// Forbid copy constructor.
TSMCoordColumn (const TSMCoordColumn&) = delete;
// Forbid assignment.
TSMCoordColumn& operator= (const TSMCoordColumn&) = delete;
// Set the shape of the coordinate vector in the given row.
virtual void setShape (rownr_t rownr, const IPosition& shape);
// Is the value shape defined in the given row?
virtual Bool isShapeDefined (rownr_t rownr);
// Get the shape of the item in the given row.
virtual IPosition shape (rownr_t rownr);
// Get a scalar value in the given row.
// The buffer pointed to by dataPtr has to have the correct length
// (which is guaranteed by the Scalar/ArrayColumn get function).
// <group>
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);
// </group>
// Put a scalar value into the given row.
// The buffer pointed to by dataPtr has to have the correct length
// (which is guaranteed by the Scalar/ArrayColumn put function).
// <group>
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);
// </group>
// Get the array value in the given row.
// The array pointed to by dataPtr has to have the correct length
// (which is guaranteed by the ArrayColumn get function).
virtual void getArrayV (rownr_t rownr, ArrayBase& dataPtr);
// Put the array value into the given row.
// The buffer pointed to by dataPtr has to have the correct length
// (which is guaranteed by the ArrayColumn put function).
virtual void putArrayV (rownr_t rownr, const ArrayBase& dataPtr);
private:
// The axis number of the coordinate.
uInt axisNr_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::ArrayBase
Non-templated base class for templated Array class.
Definition ArrayBase.h:71
casacore::IPosition
Definition IPosition.h:117
casacore::TSMColumn::TSMColumn
TSMColumn(TiledStMan *stman, int dataType, const String &columnName)
Create a column of the given type.
casacore::TSMCoordColumn::TSMCoordColumn
TSMCoordColumn(const TSMCoordColumn &)=delete
Forbid copy constructor.
casacore::TSMCoordColumn::putComplex
virtual void putComplex(rownr_t rownr, const Complex *dataPtr)
casacore::TSMCoordColumn::putArrayV
virtual void putArrayV(rownr_t rownr, const ArrayBase &dataPtr)
Put the array value into the given row.
casacore::TSMCoordColumn::getComplex
virtual void getComplex(rownr_t rownr, Complex *dataPtr)
casacore::TSMCoordColumn::putuInt
virtual void putuInt(rownr_t rownr, const uInt *dataPtr)
casacore::TSMCoordColumn::putdouble
virtual void putdouble(rownr_t rownr, const double *dataPtr)
casacore::TSMCoordColumn::axisNr_p
uInt axisNr_p
The axis number of the coordinate.
Definition TSMCoordColumn.h:157
casacore::TSMCoordColumn::setShape
virtual void setShape(rownr_t rownr, const IPosition &shape)
Set the shape of the coordinate vector in the given row.
casacore::TSMCoordColumn::~TSMCoordColumn
virtual ~TSMCoordColumn()
Frees up the storage.
casacore::TSMCoordColumn::getArrayV
virtual void getArrayV(rownr_t rownr, ArrayBase &dataPtr)
Get the array value in the given row.
casacore::TSMCoordColumn::putfloat
virtual void putfloat(rownr_t rownr, const float *dataPtr)
casacore::TSMCoordColumn::getInt64
virtual void getInt64(rownr_t rownr, Int64 *dataPtr)
casacore::TSMCoordColumn::getDComplex
virtual void getDComplex(rownr_t rownr, DComplex *dataPtr)
casacore::TSMCoordColumn::getfloat
virtual void getfloat(rownr_t rownr, float *dataPtr)
casacore::TSMCoordColumn::operator=
TSMCoordColumn & operator=(const TSMCoordColumn &)=delete
Forbid assignment.
casacore::TSMCoordColumn::getuInt
virtual void getuInt(rownr_t rownr, uInt *dataPtr)
casacore::TSMCoordColumn::putDComplex
virtual void putDComplex(rownr_t rownr, const DComplex *dataPtr)
casacore::TSMCoordColumn::getdouble
virtual void getdouble(rownr_t rownr, double *dataPtr)
casacore::TSMCoordColumn::TSMCoordColumn
TSMCoordColumn(const TSMColumn &column, uInt axisNr)
Create a coordinate column from the given column.
casacore::TSMCoordColumn::shape
virtual IPosition shape(rownr_t rownr)
Get the shape of the item in the given row.
casacore::TSMCoordColumn::putInt64
virtual void putInt64(rownr_t rownr, const Int64 *dataPtr)
casacore::TSMCoordColumn::getInt
virtual void getInt(rownr_t rownr, Int *dataPtr)
Get a scalar value in the given row.
casacore::TSMCoordColumn::isShapeDefined
virtual Bool isShapeDefined(rownr_t rownr)
Is the value shape defined in the given row?
casacore::TSMCoordColumn::putInt
virtual void putInt(rownr_t rownr, const Int *dataPtr)
Put a scalar value into the given row.
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Int64
long long Int64
Define the extra non-standard types used by Casacore (like proposed uSize, Size).
Definition aipsxtype.h:36
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::rownr_t
uInt64 rownr_t
Define the type of a row number in a table.
Definition aipsxtype.h:44