/usr/include/casacore/measures/TableMeasures/TableMeasDescBase.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 215 216 217 218 219 220 221 222 223 | //# TableMeasDescBase.h: Definition of a Measure in a Table.
//# Copyright (C) 1997,1999,2000,2001
//# 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 MEASURES_TABLEMEASDESCBASE_H
#define MEASURES_TABLEMEASDESCBASE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/measures/TableMeasures/TableMeasValueDesc.h>
#include <casacore/measures/TableMeasures/TableMeasRefDesc.h>
#include <casacore/measures/TableMeasures/TableMeasType.h>
#include <casacore/casa/Quanta/Unit.h>
#include <casacore/casa/Arrays/Vector.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class String;
class Table;
class TableDesc;
class TableRecord;
class TableColumn;
class Measure;
template<class T> class Quantum;
// <summary>
// Definition of a Measure in a Table.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Bob Garwood" date="1999/12/23" tests="tTableMeasures.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> <linkto module=Measures>Measures</linkto>
// <li> <linkto module=Tables>Tables</linkto>
// <li> <linkto class=TableMeasDesc>TableMeasDesc</linkto>
// </prerequisite>
// <synopsis>
// Abstract base class for TableMeasDesc.
// </synopsis>
// <example>
// See class <linkto class="TableMeasDesc">TableMeasDesc</linkto>.
// </example>
// <motivation>
// Creating the required keyword for the definition of a Measure
// in a Table is somewhat complicated. This class assists in that
// process.
// </motivation>
//
// <thrown>
// <li>AipsError during reconstruction if the column doesn't contain
// a MEASINFO record.
// <li>AipsError during reconstruction if the column has a MEASINFO
// but it Measure type is invalid.
// </thrown>
//
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class TableMeasDescBase
{
public:
// Null constructor.
TableMeasDescBase();
// Constructor with value and reference descriptors.
// Note that setMeasType is always called by the derived class.
TableMeasDescBase (const TableMeasValueDesc&, const TableMeasRefDesc&);
// Copy constructor.
TableMeasDescBase (const TableMeasDescBase& that);
virtual ~TableMeasDescBase();
// Clone the object.
virtual TableMeasDescBase* clone() const;
// Assignment operator.
TableMeasDescBase& operator= (const TableMeasDescBase& that);
// Makes the descriptor persistent.
// <group>
void write (TableDesc&);
void write (Table&);
// </group>
// Make the descriptor persistent if there was no refcode vector.
// This is only needed for old tables without such vectors.
void writeIfOld (const Table&);
// Get the name of the underlying column.
const String& columnName() const
{ return itsValue.columnName(); }
// Return the reference code.
uInt getRefCode() const
{ return itsRef.getRefCode(); }
// Returns True if the reference varies per row.
Bool isRefCodeVariable() const
{ return itsRef.isRefCodeVariable(); }
// Returns the name of the ref code column when the ref code is variable.
// The null string is returned if the ref code is not variable.
const String& refColumnName() const
{ return itsRef.columnName(); }
// Returns a reference to its measure reference descriptor.
const TableMeasRefDesc& getRefDesc() const
{ return itsRef; }
// Get the name of the offset column. Empty string is returned if no
// offset.
const String& offsetColumnName() const
{ return itsRef.offsetColumnName(); }
// Returns True if an offset has been defined.
Bool hasOffset() const
{ return itsRef.hasOffset(); }
// Returns True if the offset is variable.
Bool isOffsetVariable() const
{ return itsRef.isOffsetVariable(); }
// Returns True if the offset is variable and is stored in an
// ArrayMeasColumn, i.e., offsets are stored per element.
Bool isOffsetArray() const
{ return itsRef.isOffsetArray(); }
// Returns a reference to the offset.
const Measure& getOffset() const
{ return itsRef.getOffset(); }
// Returns the descriptors measure type as a String.
const String& type() const
{ return itsMeasType.type(); }
// Returns the reference code for this object given a string. Throws
// an exception if the refString is invalid for this object.
uInt refCode (const String& refString) const
{ return itsMeasType.refCode(refString); }
// Translates the refCode for the descriptors measure type.
const String& refType (uInt refCode) const
{ return itsMeasType.refType(refCode); }
// Return the Units of the Measure values
const Vector<Unit>& getUnits() const
{ return itsUnits; }
// Reset the refCode, offset, or units.
// It overwrites the value used when defining the TableMeasDesc.
// It is only possible if it was defined as fixed for the entire column.
// <group>
void resetRefCode (uInt refCode)
{ itsRef.resetRefCode (refCode); }
void resetOffset (const Measure& offset)
{ itsRef.resetOffset (offset); }
void resetUnits (const Vector<Unit>& units);
// </group>
// Reconstructs the object for the given table and column name.
static TableMeasDescBase* reconstruct (const Table& tab,
const String& columnName);
// Does this column contain table measures?
static Bool hasMeasures (const TableColumn& column);
protected:
// Set the initial reference codes and types in the table.
void initTabRef (const MeasureHolder& measHolder);
// Set the measure and possible units.
void setMeasUnits (const Measure& meas,
const Vector<Quantum<Double> >& val,
const Vector<Unit>& units);
private:
TableMeasValueDesc itsValue; //# The measure value column.
TableMeasRefDesc itsRef; //# The reference.
//# this gives access to the columns Measure type etc
TableMeasType itsMeasType;
Vector<Unit> itsUnits;
};
} //# NAMESPACE CASACORE - END
#endif
|