/usr/include/casacore/tables/DataMan/BaseMappedArrayEngine.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 | //# BaseMappedArrayEngine.h: Abstract virtual column engine for virtual->stored mapping
//# Copyright (C) 1995,1996,1997,1999,2001,2002
//# 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: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef TABLES_BASEMAPPEDARRAYENGINE_H
#define TABLES_BASEMAPPEDARRAYENGINE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/VirtColEng.h>
#include <casacore/tables/DataMan/VirtArrCol.h>
#include <casacore/casa/Arrays/IPosition.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template<class T> class ArrayColumn;
class TableColumn;
// <summary>
// Templated virtual column engine for a table array of any type.
// </summary>
// <use visibility=export>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> <linkto class=VirtualColumnEngine>VirtualColumnEngine</linkto>
// <li> <linkto class=VirtualArrayColumn>VirtualArrayColumn</linkto>
// </prerequisite>
// <etymology>
// BaseMappedArrayEngine contains for the 1-1 mapping of a virtual
// column to a stored column (both containing arrays).
// </etymology>
// <synopsis>
// BaseMappedArrayEngine is an abstract base class for virtual column engines
// which map data from the arrays in the virtual column to
// the arrays in the stored column. Note the the stored column does not need
// to be stored; it can be another virtual column, but usually it will be a
// stored column.
// Examples of classes using this base class are
// <linkto class=ScaledArrayEngine>ScaledArrayEngine</linkto> and
// <linkto class=RetypedArrayEngine>RetypedArrayEngine</linkto>.
//
// The virtual column has to be bound to the virtual column engine used
// for it. The stored column will usually be bound to a storage manager,
// but any other suitable data manager is possible. E.g. it is
// possible to use <src>MappedArrayEngine<StokesVector,float></src>
// to map a StokesVector to a float column, which in its turn uses
// <src>ScaledArrayEngine<float,Int></src> to store it as integers.
// Note that the names of the virtual and stored column have to be different,
// otherwise the table system cannot distinguish them.
//
// This base class does several tasks for the derived classes.
// The main one is to keep and handle the information about the virtual
// and stored column. The name of the stored column is written as a keyword
// in the virtual column. In this way the stored column is known when
// a table is read back. It also creates <src>(RO)ArrayColumn<T></src>
// objects to access the stored column. The function roColumn gives
// read access, while rwColumn gives write access.
//
// An engine object should be used for one column only, because the stored
// column name is part of the engine. If it would be used for more than
// one column, they would all share the same stored column.
// When the engine is bound to a column, it is checked if the name
// of that column matches the given virtual column name.
//
// The engine can be used for a column containing any kind of array
// (thus direct or indirect, fixed or variable shaped)) as long as the
// virtual array can be stored in the stored array. Thus a fixed shaped
// virtual can use a variable shaped stored, but not vice versa.
// A fixed shape indirect virtual can use a stored with direct arrays.
//
// The DataManager framework contains various virtual functions.
// This class implements several, but not all of them. Furthermore
// some implementations may not be optimal or correct for derived classes.
// Hereafter follows a list of functions which may need implementation
// in derived classes. The classes mentioned in the examples below show
// implementations of these functions.
// <ul>
// <li>
// The following (virtual) functions have to be implemented:
// <dl>
// <dt><src>
// ~... (the destructor)
// </src>
// <dt><src>
// DataManager* clone() const;
// </src>
// <dt><src>
// String dataManagerType() const;
// </src>
// <dt><src>
// static void registerClass();
// </src>
// <dt><src>
// static DataManager* makeObject (const String& dataManagerType);
// </src>
// <dt><src>
// void getArray (uInt rownr, Array<T>& data);
// </src>
// <dt><src>
// void putArray (uInt rownr, const Array<T>& data);
// </src>
// (only if the virtual column is writable).
// </dl>
// <li>
// For efficiency reasons it could be better to implement the following
// functions:
// <dl>
// <dt><src>
// void getSlice (uInt rownr, const Slicer& slicer, Array<T>& data);
// </src>
// <dt><src>
// void putSlice (uInt rownr, const Slicer& slicer,
// const Array<T>& data);
// </src>
// <dt><src>
// void getArrayColumn (Array<T>& data);
// </src>
// <dt><src>
// void putArrayColumn (const Array<T>& data);
// </src>
// <dt><src>
// void getColumnSlice (const Slicer& slicer, Array<T>& data);
// </src>
// <dt><src>
// void putColumnSlice (const Slicer& slicer, const Array<T>& data);
// </src>
// </dl>
// <li>
// The following functions have to be implemented when the shapes
// of the virtual and stored arrays are not the same.
// <dl>
// <dt><src>
// void setShapeColumn (const IPosition& shape);
// </src>
// <dt><src>
// void setShape (uInt rownr, const IPosition& shape);
// </src>
// <dt><src>
// uInt ndim (uInt rownr);
// </src>
// <dt><src>
// IPosition shape (uInt rownr);
// </src>
// </dl>
// <li>
// The following functions deal with the initialization and persistence
// of engine specific variables. When the class has variables of its
// own, these functions may need to be implemented. Implementations of
// create and prepare have to call the similar functions in this base class.
// <dl>
// <dt><src>
// void close (AipsIO& ios);
// </src>
// <dt><src>
// void create (uInt nrrow);
// </src>
// <dt><src>
// void open (uInt nrrow, AipsIO& ios);
// </src>
// <dt><src>
// void prepare();
// </src>
// </dl>
// <li>
// The following functions do not need to be declared and implemented
// in derived classes unless it is a very special case.
// <dl>
// <dt><src>
// String dataManagerName() const;
// </src>
// <dt><src>
// Bool canAddRow() const;
// </src>
// <dt><src>
// Bool canRemoveRow() const;
// </src>
// <dt><src>
// void addRow (uInt nrrow);
// </src>
// <dt><src>
// void removeRow (uInt rownr);
// </src>
// <dt><src>
// DataManagerColumn* makeDirArrColumn (const String& columnName,
// int dataType,
// const String& dataTypeId);
// </src>
// <dt><src>
// DataManagerColumn* makeIndArrColumn (const String& columnName,
// int dataType,
// const String& dataTypeId);
// </src>
// <dt><src>
// Bool isWritable() const;
// </src>
// <dt><src>
// Bool isShapeDefined (uInt rownr);
// </src>
// </dl>
// </ul>
// </synopsis>
// <example>
// The derived classes
// <linkto class=ScaledArrayEngine>ScaledArrayEngine</linkto> and
// <linkto class=RetypedArrayEngine>RetypedArrayEngine</linkto>
// are two examples of how to derive a class from this base class.
// Note that ScaledArrayEngine does not need to implement functions
// dealing with shapes, because it can use them from this base class.
// On the other hand they need to be implemented in RetypedArrayEngine.
// </example>
// <motivation>
// This base class implements several functions making the implementation
// of derived classes simpler. Many details are implemented here, so often
// only the basic mapping functions (get, put) need to be implemented
// in a derived class.
// </motivation>
// <templating arg=VirtualType>
// <li> default constructor
// <li> copy constructor
// <li> assignment operator
// <li> <src>static String dataTypeId(); // unique name of the class</src>
// </templating>
// <templating arg=StoredType>
// <li> Default constructor
// <li> Copy constructor
// <li> Assignment operator
// </templating>
template<class VirtualType, class StoredType> class BaseMappedArrayEngine : public VirtualColumnEngine, public VirtualArrayColumn<VirtualType>
{
public:
// Get the virtual column name.
const String& virtualName() const;
// Get the stored column name.
const String& storedName() const;
// The column is writable if the underlying stored column is writable.
virtual Bool isWritable() const;
protected:
// Construct an engine to convert the virtual column to the stored column.
// StoredColumnName is the name of the column where the converted
// data will be put and must have data type StoredType.
// The virtual column using this engine must have data type VirtualType.
// By default the virtual column is assumed to be writable.
// Use setWritable to unset it.
BaseMappedArrayEngine (const String& virtualColumnName,
const String& storedColumnName);
// Destructor is mandatory.
~BaseMappedArrayEngine();
// The default constructor is required for reconstruction of the
// engine when a table is read back.
BaseMappedArrayEngine();
// Copy constructor is only used by copy constructor of derived classes.
// (so it is made protected).
BaseMappedArrayEngine
(const BaseMappedArrayEngine<VirtualType, StoredType>&);
// Set if the column is writable or not.
void setWritable (Bool isWritable);
// Set the virtual and stored column name.
void setNames (const String& virtualName, const String& storedName);
// Give access to the stored column.
// This can be used by the derived classes to get/put data.
inline ArrayColumn<StoredType>& column();
// Create the column object for the array column in this engine.
// It will check if the given column name matches the virtual
// column name. This assures that the engine is bound to the
// correct column.
virtual DataManagerColumn* makeIndArrColumn (const String& columnName,
int dataType,
const String& dataTypeId);
// Initialize the object for a new table.
// It defines a virtual column keyword telling the stored column name.
// Initially the table has the given number of rows.
// A derived class can have its own create function, but that should
// always call this create function.
virtual void create (uInt initialNrrow);
// Preparing consists of setting the writable switch and
// adding the initial number of rows in case of create.
// It reads the stored column name from the virtual column keywords.
// A derived class can have its own prepare function, but that should
// always call this prepare function.
virtual void prepare();
// Do the 2 stages of the prepare (define columns and adding rows).
// <group>
void prepare1();
void prepare2();
// </group>
// Rows are added to the end of the table.
// If the virtual column has FixedShape arrays and the stored not,
// the shape in each stored row will be set.
// This assures that the arrays are properly defined in each row,
// so putSlice can be used without problems.
// <br>The second version is used by prepare2, because in case a column is
// added to an already existing table, table.nrow() gives the existing
// number of columns instead of 0.
// <group>
virtual void addRow (uInt nrrow);
virtual void addRowInit (uInt startRow, uInt nrrow);
// </group>
// Set the shape of the FixedShape arrays in the column.
// This function only gets called if the column has FixedShape arrays.
// The shape gets saved and used to set the shape of the arrays
// in the stored in case the stored has non-FixedShape arrays.
// This implementation assumes the shape of virtual and stored arrays
// are the same. If not, it has to be overidden in a derived class.
virtual void setShapeColumn (const IPosition& shape);
// Define the shape of the array in the given row.
// It will define the shape of the (underlying) array.
// This implementation assumes the shape of virtual and stored arrays
// are the same. If not, it has to be overidden in a derived class.
virtual void setShape (uInt rownr, const IPosition& shape);
// Test if the (underlying) array is defined in the given row.
virtual Bool isShapeDefined (uInt rownr);
// Get the dimensionality of the (underlying) array in the given row.
// This implementation assumes the dimensionality of virtual and
// stored arrays are the same. If not, it has to be overidden in a
// derived class.
virtual uInt ndim (uInt rownr);
// Get the shape of the (underlying) array in the given row.
// This implementation assumes the shape of virtual and stored arrays
// are the same. If not, it has to be overidden in a derived class.
virtual IPosition shape (uInt rownr);
// The data manager can handle changing the shape of an existing array
// when the underlying stored column can do it.
virtual Bool canChangeShape() const;
// Make a table column object for the given column.
// This has to be used in the create function, otherwise it could not
// create a TableColumn object to store data in the column keywords.
TableColumn makeTableColumn (const String& columnName);
// Get an array in the given row.
// This will scale and offset from the underlying array.
virtual void getArray (uInt rownr, Array<VirtualType>& array);
// Put an array in the given row.
// This will scale and offset to the underlying array.
virtual void putArray (uInt rownr, const Array<VirtualType>& array);
// Get a section of the array in the given row.
// This will scale and offset from the underlying array.
virtual void getSlice (uInt rownr, const Slicer& slicer,
Array<VirtualType>& array);
// Put into a section of the array in the given row.
// This will scale and offset to the underlying array.
virtual void putSlice (uInt rownr, const Slicer& slicer,
const Array<VirtualType>& array);
// Get an entire column.
// This will scale and offset from the underlying array.
virtual void getArrayColumn (Array<VirtualType>& array);
// Put an entire column.
// This will scale and offset to the underlying array.
virtual void putArrayColumn (const Array<VirtualType>& array);
// Get some array values in the column.
// This will scale and offset from the underlying array.
virtual void getArrayColumnCells (const RefRows& rownrs,
Array<VirtualType>& data);
// Put some array values in the column.
// This will scale and offset to the underlying array.
virtual void putArrayColumnCells (const RefRows& rownrs,
const Array<VirtualType>& data);
// Get a section of all arrays in the column.
// This will scale and offset from the underlying array.
void getColumnSlice (const Slicer& slicer, Array<VirtualType>& array);
// Put a section of all arrays in the column.
// This will scale and offset to the underlying array.
void putColumnSlice (const Slicer& slicer, const Array<VirtualType>& array);
// Get a section of some arrays in the column.
// This will scale and offset from the underlying array.
virtual void getColumnSliceCells (const RefRows& rownrs,
const Slicer& slicer,
Array<VirtualType>& data);
// Put into a section of some arrays in the column.
// This will scale and offset to the underlying array.
virtual void putColumnSliceCells (const RefRows& rownrs,
const Slicer& slicer,
const Array<VirtualType>& data);
// Map the virtual shape to the stored shape.
// By default is returns the virtual shape.
virtual IPosition getStoredShape (uInt rownr,
const IPosition& virtualShape);
// Map the slicer for a virtual shape to a stored shape.
// By default it returns the virtual input slicer.
virtual Slicer getStoredSlicer (const Slicer& virtualSlicer) const;
// Map StoredType array to VirtualType array.
// This is meant when reading an array from the stored column.
// The default implementation throws an exception.
virtual void mapOnGet (Array<VirtualType>& array,
const Array<StoredType>& stored);
// Map Bool array to bit flags array.
// This is meant when writing an array into the stored column.
// The default implementation throws an exception.
virtual void mapOnPut (const Array<VirtualType>& array,
Array<StoredType>& stored);
private:
// Assignment is not needed and therefore forbidden
// (so it is made private and not implemented).
BaseMappedArrayEngine<VirtualType, StoredType>& operator=
(const BaseMappedArrayEngine<VirtualType, StoredType>&);
//# Now define the data members.
String virtualName_p; //# virtual column name
String storedName_p; //# stored column name
Bool isWritable_p; //# is virtual column writable?
Bool tempWritable_p; //# True = create phase, so column
//# is temporarily writable
//# False = asks stored column
uInt initialNrrow_p; //# initial #rows in case of create
Bool arrayIsFixed_p; //# True = virtual is FixedShape array
IPosition shapeFixed_p; //# shape in case FixedShape array
ArrayColumn<StoredType>* column_p; //# the stored column
};
template<class VirtualType, class StoredType>
inline const String&
BaseMappedArrayEngine<VirtualType, StoredType>::virtualName() const
{ return virtualName_p; }
template<class VirtualType, class StoredType>
inline const String&
BaseMappedArrayEngine<VirtualType, StoredType>::storedName() const
{ return storedName_p; }
template<class VirtualType, class StoredType>
inline void
BaseMappedArrayEngine<VirtualType, StoredType>::setNames
(const String& virtualName, const String& storedName)
{
virtualName_p = virtualName;
storedName_p = storedName;
}
template<class VirtualType, class StoredType>
inline void
BaseMappedArrayEngine<VirtualType, StoredType>::setWritable (Bool isWritable)
{ isWritable_p = isWritable; }
template<class VirtualType, class StoredType>
inline ArrayColumn<StoredType>&
BaseMappedArrayEngine<VirtualType, StoredType>::column()
{ return *column_p; }
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/tables/DataMan/BaseMappedArrayEngine.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|