MSMDirColumn.h

Go to the documentation of this file.

// # MSMDirColumn.h: Memory storage manager for fixed shape 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_MSMDIRCOLUMN_H
#define TABLES_MSMDIRCOLUMN_H
 
// # Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/MSMColumn.h>
#include <casacore/casa/Arrays/Array.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
// <summary>
// Memory storage manager for 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>
// MSMDirColumn handles arrays in a table column.
// It only keeps them in memory, so they are not persistent.
// </synopsis>
 
// # <todo asof="$DATE:$">
// # A List of bugs, limitations, extensions or planned refinements.
// # </todo>
 
class MSMDirColumn : public MSMColumn {
 public:
  // Create a column of the given type.
  MSMDirColumn(MSMBase* smptr, int dataType);
 
  // Frees up the storage.
  virtual ~MSMDirColumn();
 
  // Forbid copy constructor.
  MSMDirColumn(const MSMDirColumn&) = delete;
 
  // Forbid assignment.
  MSMDirColumn& operator=(const MSMDirColumn&) = delete;
 
  // Set the (fixed) shape of the arrays in the entire column.
  virtual void setShapeColumn(const IPosition& shape);
 
  // Add (newNrrow-oldNrrow) rows to the column.
  // Allocate the data arrays in these rows if the shape is fixed.
  virtual void addRow(rownr_t newNrrow, rownr_t oldNrrow);
 
  // Get the dimensionality of the item in the given row.
  // 0 is returned if there is no array.
  virtual 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.
  virtual IPosition shape(rownr_t rownr);
 
  // 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).
  virtual 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).
  virtual 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).
  virtual 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).
  virtual void putSliceV(rownr_t rownr, const Slicer&, const ArrayBase& arr);
 
  // Remove the value in the given row.
  void remove(rownr_t rownr);
 
  // Let the column create its arrays.
  void doCreate(rownr_t nrrow);
 
 private:
  template <typename T>
  inline void doGetSlice(rownr_t rownr, const Slicer& slicer, Array<T>& data) {
    Array<T> arr(shape_p, static_cast<T*>(getArrayPtr(rownr)), SHARE);
    data = arr(slicer);
  }
 
  template <typename T>
  inline void doPutSlice(rownr_t rownr, const Slicer& slicer, const Array<T>& data) {
    Array<T> arr(shape_p, static_cast<T*>(getArrayPtr(rownr)), SHARE);
    arr(slicer) = data;
  }
 
  // Delete the array in the given row.
  void deleteArray(rownr_t rownr);
 
  // The shape of the array.
  IPosition shape_p;
  // The nr of elements in the array.
  rownr_t nrelem_p;
};
 
}  // namespace casacore
 
#endif