/usr/include/casacore/tables/TaQL/TableExprId.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 | //# TableExprId.h: The identification of a TaQL selection subject
//# 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: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$
#ifndef TABLES_TABLEEXPRID_H
#define TABLES_TABLEEXPRID_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/stdvector.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class RecordInterface;
class TableExprData;
// <summary>
// The identification of a TaQL selection subject.
// </summary>
// <use visibility=export>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="TableExprNode">TableExprNode</linkto>.
// </prerequisite>
// <synopsis>
// This class provides the user the ability to identify the data objects
// to test in a TaQL expression. In this way a TaQL expression is not
// limited to tables, but can be used for any set of data.
// Three types are available:
// <ol>
// <li> A row number giving the row to test in a table.
// It also contains a sequence number (0..n) which is used to get the
// result calculated by aggregate functions.
// <li> A <linkto class=RecordInterface>RecordInterface</linkto>
// object giving the record to test.
// <li> A <linkto class=TableExprData>TableExprData</linkto>
// object giving the abstract base class of an object holding
// the data to test. In this way any data can be used.
// </ol>
// The TaQL expression must be setup with this in mind by constructing
// the appropriate <linkto class=TableExprNode>TableExprNode</linkto>
// leaf objects.
// <br>
// When used for tables, the function <linkto class=Table>Table::col</linkto>
// should be used to create the <src>TableExprNode</src> objects for the
// table columns to be used in the expression.
// <br>
// For the other cases class
// <linkto class=TableExprNodeRecordField>TableExprNodeRecordField</linkto>
// has to be used to know the index of the fields in the expression.
// It uses a record (description) for this purpose.
// </synopsis>
// <example>
// <srcblock>
// </srcBlock>
// </example>
// <motivation>
// This class makes it possible that TaQL can be used in a very versatile way.
// </motivation>
//# <todo asof="1996/03/12">
//# </todo>
class TableExprId
{
public:
// Default constructor sets rownr to -1.
TableExprId();
// Construct it from a row number.
TableExprId (uInt rowNumber);
// Construct it from a Record object.
TableExprId (const RecordInterface&);
// Construct it from pointers to data.
TableExprId (const TableExprData& data);
~TableExprId()
{}
// Is the id given by row number?
Bool byRow() const;
// Is the id given as a RecordInterface?
Bool byRecord() const;
// Is the id given as a TableExprData?
Bool byData() const;
// Get the row number.
Int64 rownr() const;
// Get the Record reference.
const RecordInterface& record() const;
// Get the data reference.
const TableExprData& data() const;
// Set the row number.
void setRownr (uInt rownr);
// Set the record.
void setRecord (const RecordInterface&);
private:
Int type_p;
union {
Int64 row_p;
const RecordInterface* record_p;
const TableExprData* data_p;
};
};
inline TableExprId::TableExprId()
: type_p (0),
row_p (-1)
{}
inline TableExprId::TableExprId (uInt rowNumber)
: type_p (0),
row_p (rowNumber)
{}
inline TableExprId::TableExprId (const RecordInterface& record)
: type_p (-1),
record_p (&record)
{}
inline TableExprId::TableExprId (const TableExprData& data)
: type_p (-2),
data_p (&data)
{}
inline Int64 TableExprId::rownr() const
{
return row_p;
}
inline const RecordInterface& TableExprId::record() const
{
return *record_p;
}
inline const TableExprData& TableExprId::data() const
{
return *data_p;
}
inline void TableExprId::setRownr (uInt rownr)
{
row_p = rownr;
}
inline void TableExprId::setRecord (const RecordInterface& record)
{
record_p = &record;
}
inline Bool TableExprId::byRow() const
{
return type_p >= 0;
}
inline Bool TableExprId::byRecord() const
{
return type_p == -1;
}
inline Bool TableExprId::byData() const
{
return type_p == -2;
}
} //# NAMESPACE CASACORE - END
#endif
|