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
|
//# BaseTabIter.h: Base class for table iterator
//# Copyright (C) 1994,1995,1996,1997,1999
//# 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_BASETABITER_H
#define TABLES_BASETABITER_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/Tables/Table.h>
#include <casacore/casa/Utilities/Compare.h>
#include <casacore/casa/Containers/Block.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class TableColumn;
class RefTable;
class String;
// <summary>
// Base class for table iterator
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> BaseTable
// <li> TableIterator
// </prerequisite>
// <etymology>
// BaseTableIterator is the base class for the classes doing
// the actual iterating through a table.
// </etymology>
// <synopsis>
// BaseTableIterator is the base class for the table iterators.
// It is a letter class of the envelope TableIterator.
// Currently there are no classes derived from BaseTableIterator,
// since it can do all the work itself. However, in the future
// this need not to be true anymore.
//
// BaseTableIterator iterates by sorting the table in the required
// order and then creating a RefTable for each step containing the
// rows for that iteration step. Each iteration step assembles the
// rows with equal key values.
// </synopsis>
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class BaseTableIterator
{
public:
// Create the table iterator to iterate through the given
// columns in the given order. The given compare objects
// will be used for the sort and to compare if values are equal.
// If a compare object in cmpObjs is null, the default ObjCompare<T>
// will be used.
// If cacheIterationBoundaries is set to true then the iteration
// boundaries computed at construction time while sorting the table
// are used when advancing with next(). Otherwise, for each next()
// call the comparison functions are reevaluated again to get the
// iteration boundary. This improves performance in general but will
// break existing applications that change the comparison objects
// (cmpObjs) between iterations.
BaseTableIterator (BaseTable*, const Block<String>& columnNames,
const Block<CountedPtr<BaseCompare> >& cmpObjs,
const Block<Int>& orders,
int option,
bool cacheIterationBoundaries = false);
// Clone this iterator.
BaseTableIterator* clone() const;
virtual ~BaseTableIterator();
// Reset the iterator (i.e. restart iteration).
virtual void reset();
// Return the next group.
virtual BaseTable* next();
virtual void copyState(const BaseTableIterator &);
// Report Name of slowest sort column that changed (according to the
// comparison function) to terminate the most recent call to next()
// Enables clients to sense iteration boundary properties
// and organize associated iterations
inline const String& keyChangeAtLastNext() const { return keyChangeAtLastNext_p; };
protected:
BaseTable* sortTab_p; //# Table sorted in iteration order
rownr_t lastRow_p; //# last row used from reftab
uInt nrkeys_p; //# nr of columns in group
String keyChangeAtLastNext_p; //# name of column that terminated most recent next()
PtrBlock<BaseColumn*> colPtr_p; //# pointer to column objects
Block<CountedPtr<BaseCompare> > cmpObj_p; //# comparison object per column
// Copy constructor (to be used by clone)
BaseTableIterator (const BaseTableIterator&);
BaseTable* noCachedIterBoundariesNext();
private:
// Assignment is not needed, because the assignment operator in
// the envelope class TableIterator has reference semantics.
// Declaring it private, makes it unusable.
BaseTableIterator& operator= (const BaseTableIterator&);
Block<void*> lastVal_p; //# last value per column
Block<void*> curVal_p; //# current value per column
std::shared_ptr<Vector<rownr_t>> sortIterBoundaries_p;
std::shared_ptr<Vector<size_t>> sortIterKeyIdxChange_p;
Vector<rownr_t>::iterator sortIterBoundariesIt_p;
Vector<size_t>::iterator sortIterKeyIdxChangeIt_p;
RefTable* aRefTable_p;
};
} //# NAMESPACE CASACORE - END
#endif
|
