File: SSMIndStringColumn.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 (131 lines) | stat: -rw-r--r-- 4,338 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
//# SSMIndStringColumn.h: An Indirect String Array Column in the SSM
//# Copyright (C) 2000
//# 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_SSMINDSTRINGCOLUMN_H
#define TABLES_SSMINDSTRINGCOLUMN_H


//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/SSMDirColumn.h>

namespace casacore { //# NAMESPACE CASACORE - BEGIN

//# Forward declarations


// <summary>
// An Indirect String Array Column in the Standard Storage Manager.
// </summary>

// <use visibility=local>

// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tSSMStringHandler.cc">
// </reviewed>

// <prerequisite>
//# Classes you should understand before using this one.
//   <li> <linkto class=SSMBase>SSMBase</linkto>
//   <li> <linkto class=SSMDirColumn>SSMColumn</linkto>
//   <li> <linkto class=SSMStringHandler>SSMStringHandler</linkto>
// </prerequisite>

// <etymology>
// SSMIndStringColumn represents an Indirect String Array Column in the 
// Standard Storage Manager.
// </etymology>

// <synopsis>
// SSMIndStringColumn handles indirect variable shaped string arrays.
// Note that indirect fixed shape string arrays are handled by
// <linkto class=SSMDirColumn>SSMDirColumn</linkto>.
// <p>
// All string array access is handled by class
// <linkto class=SSMStringHandler>SSMStringHandler</linkto>, so
// SSMIndStringColumn is merely an interface to this class.
// The only thing it does is accessing the bucketnr, offset, and length
// in the data bucket.
// </synopsis>
  
// <motivation>
// The reason that indirect string arrays are handled here instead of
// in <linkto class=SSMIndColumn>SSMIndColumn</linkto> is that the string
// buckets are more disk space efficient when string arrays are frequently
// updated.
// </motivation>

//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>


class SSMIndStringColumn : public SSMDirColumn
{
public:
  // Create a SSMIndStringColumn object with the given parent.
  // It initializes the various variables.
  // It keeps the pointer to its parent (but does not own it).
  SSMIndStringColumn (SSMBase* aParent, int aDataType, uInt aColNr);
  
  virtual ~SSMIndStringColumn();

  // Forbid copy constructor.
  SSMIndStringColumn (const SSMIndStringColumn&) = delete;
  
  // Forbid assignment.
  SSMIndStringColumn& operator= (const SSMIndStringColumn&) = delete;

  // Get an array value in the given row.
  // An exception is thrown if no array is defined in this row.
  virtual void getArrayV (rownr_t rownr, ArrayBase& dataPtr);
  
  // Put an array value in the given row.
  virtual void putArrayV (rownr_t rownr, const ArrayBase& dataPtr);

  // Set the shape of the array in the given row.
  void setShape (rownr_t aRowNr, const IPosition& aShape);
  
  // Get the shape of the array in the given row.
  virtual IPosition shape (rownr_t aRowNr);
  
  // This storage manager can handle changing array shapes.
  Bool canChangeShape() const;

  // Is the shape defined (i.e. is there an array) in this row?
  virtual Bool isShapeDefined (rownr_t aRowNr);

  // Get the dimensionality of the item in the given row.
  virtual uInt ndim (rownr_t aRowNr);
};



} //# NAMESPACE CASACORE - END

#endif