Loading...
Searching...
No Matches
MSMIndColumn.h
Go to the documentation of this file.
//# MSMIndColumn.h: Memory storage manager for variable shaped table arrays
//# Copyright (C) 2003
//# 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_MSMINDCOLUMN_H
#define TABLES_MSMINDCOLUMN_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/MSMColumn.h>
#include <casacore/tables/DataMan/MSMBase.h>
#include <casacore/casa/Arrays/IPosition.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Mmeory storage manager for variable shaped table arrays
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> MSMBase
// <li> MSMColumn
// </prerequisite>
// <synopsis>
// StManColumnArrayAipsIO handles indirect arrays in a table column.
//
// An array (or section of an array) is only read when needed.
// It, however, caches the array shape using the helper class
// StIndArray. Pointers to these objects
// are maintained using the standard StManColumnAipsIO facilities.
// When the column gets written, the offsets in the StManArrayFile file
// get written. Those will be read back when the column is read in.
//
// When a row gets deleted or when the array gets bigger, the file space
// is lost. This storage manager is a simple one and no attempts
// are done to make it smart.
// </synopsis>
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class MSMIndColumn : public MSMColumn
{
public:
// Create a column of the given type.
MSMIndColumn (MSMBase*, int dataType);
// Frees up the storage.
~MSMIndColumn();
// Forbid copy constructor.
MSMIndColumn (const MSMIndColumn&) = delete;
// Forbid assignment.
MSMIndColumn& operator= (const MSMIndColumn&) = delete;
// Set the (fixed) shape of the arrays in the entire column.
void setShapeColumn (const IPosition& shape);
// Get the column shape.
const IPosition& columnShape() const
{ return fixedShape_p; }
// Set the shape of the array in the given row and allocate the array
// in the file.
void setShape (rownr_t rownr, const IPosition& shape);
// Is the shape defined (i.e. is there an array) in this row?
Bool isShapeDefined (rownr_t rownr);
// Get the dimensionality of the item in the given row.
// 0 is returned if there is no array.
uInt ndim (rownr_t rownr);
// Get the shape of the array in the given row.
// An zero-length IPosition is returned if there is no array.
IPosition shape (rownr_t rownr);
// This storage manager can handle changing array shapes.
Bool canChangeShape() const;
// Get an array value in the given row.
// The buffer given by <src>arr</src> has to have the correct length
// (which is guaranteed by the ArrayColumn get function).
void getArrayV (rownr_t rownr, ArrayBase& arr);
// Put an array value into the given row.
// The buffer given by <src>arr</src> has to have the correct length
// (which is guaranteed by the ArrayColumn put function).
void putArrayV (rownr_t rownr, const ArrayBase& arr);
// Get a section of the array in the given row.
// The buffer given by <src>arr</src> has to have the correct length
// (which is guaranteed by the ArrayColumn getSlice function).
void getSliceV (rownr_t rownr, const Slicer&, ArrayBase& arr);
// Put into a section of the array in the given row.
// The buffer given by <src>arr</src> has to have the correct length
// (which is guaranteed by the ArrayColumn putSlice function).
void putSliceV (rownr_t rownr, const Slicer&, const ArrayBase& arr);
// Remove the value in the given row.
// This will result in lost file space.
void remove (rownr_t rownr);
private:
class Data {
public:
Data (const IPosition& shape, int dtype, int elemSize);
~Data();
Data (const Data&) = delete;
Data& operator= (const Data&) = delete;
const IPosition& shape() const {return shape_p;}
void* data() {return data_p;}
private:
IPosition shape_p;
void* data_p;
bool data_is_string;
};
// The shape of all arrays in case it is fixed.
IPosition fixedShape_p;
// The size at the start of the data (for the IPosition).
uInt startSize_p;
// Delete the array in the given row.
void deleteArray (rownr_t rownr);
// Read the shape at the given row.
// It throws an exception if undefined.
Data* getShape (rownr_t rownr);
// Get a pointer to the data array.
void* getDataPtr (rownr_t rownr)
{ return (char*)(getShape(rownr)) + startSize_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::MSMBase
Definition MSMBase.h:66
casacore::MSMColumn::MSMColumn
MSMColumn(MSMBase *smptr, int dataType, Bool byPtr)
Create a column of the given type.
casacore::MSMIndColumn::Data
Definition MSMIndColumn.h:141
casacore::MSMIndColumn::Data::data
void * data()
Definition MSMIndColumn.h:148
casacore::MSMIndColumn::Data::Data
Data(const IPosition &shape, int dtype, int elemSize)
casacore::MSMIndColumn::Data::data_p
void * data_p
Definition MSMIndColumn.h:151
casacore::MSMIndColumn::Data::Data
Data(const Data &)=delete
casacore::MSMIndColumn::Data::data_is_string
bool data_is_string
Definition MSMIndColumn.h:152
casacore::MSMIndColumn::Data::shape_p
IPosition shape_p
Definition MSMIndColumn.h:150
casacore::MSMIndColumn::Data::operator=
Data & operator=(const Data &)=delete
casacore::MSMIndColumn::Data::~Data
~Data()
casacore::MSMIndColumn::Data::shape
const IPosition & shape() const
Definition MSMIndColumn.h:147
casacore::MSMIndColumn::remove
void remove(rownr_t rownr)
Remove the value in the given row.
casacore::MSMIndColumn::canChangeShape
Bool canChangeShape() const
This storage manager can handle changing array shapes.
casacore::MSMIndColumn::isShapeDefined
Bool isShapeDefined(rownr_t rownr)
Is the shape defined (i.e.
casacore::MSMIndColumn::putSliceV
void putSliceV(rownr_t rownr, const Slicer &, const ArrayBase &arr)
Put into a section of the array in the given row.
casacore::MSMIndColumn::getArrayV
void getArrayV(rownr_t rownr, ArrayBase &arr)
Get an array value in the given row.
casacore::MSMIndColumn::setShapeColumn
void setShapeColumn(const IPosition &shape)
Set the (fixed) shape of the arrays in the entire column.
casacore::MSMIndColumn::~MSMIndColumn
~MSMIndColumn()
Frees up the storage.
casacore::MSMIndColumn::operator=
MSMIndColumn & operator=(const MSMIndColumn &)=delete
Forbid assignment.
casacore::MSMIndColumn::getShape
Data * getShape(rownr_t rownr)
Read the shape at the given row.
casacore::MSMIndColumn::getSliceV
void getSliceV(rownr_t rownr, const Slicer &, ArrayBase &arr)
Get a section of the array in the given row.
casacore::MSMIndColumn::setShape
void setShape(rownr_t rownr, const IPosition &shape)
Set the shape of the array in the given row and allocate the array in the file.
casacore::MSMIndColumn::putArrayV
void putArrayV(rownr_t rownr, const ArrayBase &arr)
Put an array value into the given row.
casacore::MSMIndColumn::columnShape
const IPosition & columnShape() const
Get the column shape.
Definition MSMIndColumn.h:94
casacore::MSMIndColumn::deleteArray
void deleteArray(rownr_t rownr)
Delete the array in the given row.
casacore::MSMIndColumn::fixedShape_p
IPosition fixedShape_p
The shape of all arrays in case it is fixed.
Definition MSMIndColumn.h:155
casacore::MSMIndColumn::shape
IPosition shape(rownr_t rownr)
Get the shape of the array in the given row.
casacore::MSMIndColumn::MSMIndColumn
MSMIndColumn(MSMBase *, int dataType)
Create a column of the given type.
casacore::MSMIndColumn::startSize_p
uInt startSize_p
The size at the start of the data (for the IPosition).
Definition MSMIndColumn.h:157
casacore::MSMIndColumn::getDataPtr
void * getDataPtr(rownr_t rownr)
Get a pointer to the data array.
Definition MSMIndColumn.h:168
casacore::MSMIndColumn::ndim
uInt ndim(rownr_t rownr)
Get the dimensionality of the item in the given row.
casacore::MSMIndColumn::MSMIndColumn
MSMIndColumn(const MSMIndColumn &)=delete
Forbid copy constructor.
casacore::Slicer
Definition Slicer.h:287
casacore::StManColumnBase::dtype
DataType dtype() const
Definition StManColumnBase.h:90
casacore::StManColumnBase::elemSize
Int elemSize() const
Return the size of an element of the column's data type.
Definition StManColumnBase.h:95
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
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
casacore::dataType
DataType dataType(const RecordFieldId &) const