File: MSMIndColumn.h

package info (click to toggle)
casacore 3.8.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,912 kB
  • sloc: cpp: 471,569; fortran: 16,372; ansic: 7,416; yacc: 4,714; lex: 2,346; sh: 1,865; python: 629; perl: 531; sed: 499; csh: 201; makefile: 32
file content (176 lines) | stat: -rw-r--r-- 5,760 bytes parent folder | download | duplicates (2)
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
//# 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