/usr/include/casacore/measures/TableMeasures/TableMeasValueDesc.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 | //# TableMeasValueDesc.h: Definition of a MeasValue 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_TABLEMEASVALUEDESC_H
#define MEASURES_TABLEMEASVALUEDESC_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class ColumnDesc;
class Table;
class TableDesc;
class TableRecord;
// <summary>
// Definition of a Measure Value in a Table.
// </summary>
// <use visibility=export>
// <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>
// TableMeasValueDesc is a class for setting up the Measure value
// component of the TableMeasDesc in the TableMeasures system. Its purpose
// it to specify the Table column to be used as a Measure column through
// which Measures are subsequently written to and read from via
// either an <linkto class="ArrayMeasColumn">ArrayMeasColumn</linkto>
// or <linkto class="ScalarMeasColumn">ScalarMeasColumn</linkto> object.
//
// The column used as the Measure column is always an ArrayColumn<Double>
// irrespective of whether it is to store scalars or arrays of Measures and
// irrespective of the type of Measure.
// </synopsis>
// <example>
//<ol>
// <li>
// <srcblock>
// // Add a column to the table. This column is to be used to store
// // MPositions. Measure columns are alway ArrayColumn<Double>
// ArrayColumnDesc<Double> cdPosCol("MPosColumn", "MPosition column");
// td.addColumn(cdPosCol);
// ...
// // create the TableMeasValueDesc object
// TableMeasValueDesc valueDesc(td, "MPosColumn");
// </srcblock>
//</ol>
// For an example of the use of the TableMeasValueDesc class in the context
// of a full TableMeasDesc declaration 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 if the specified column doesn't exist or it isn't
// an ArrayColumn or its type is not Double.
// </thrown>
//
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class TableMeasValueDesc
{
public:
// Null constructor
TableMeasValueDesc();
// Construct the MeasValue column descriptor for the given column.
// The column must be a column of type Double and should exist in
// the TableDesc.
TableMeasValueDesc (const TableDesc&, const String& columnName);
// Construct the MeasValue column descriptor for the given column.
// Checking if the column exists is done in the write function.
// <group>
TableMeasValueDesc (const String& columnName)
: itsColumn (columnName) {}
TableMeasValueDesc (const Char* columnName)
: itsColumn (columnName) {}
// </group>
// Copy constructor.
TableMeasValueDesc (const TableMeasValueDesc& that);
~TableMeasValueDesc();
// Assignment operator.
TableMeasValueDesc& operator= (const TableMeasValueDesc& that);
// Write the type, unit, and MEASINFO record into the column keywords.
// It checks if the column exists in the given table description.
// <group>
void write (TableDesc&, const TableRecord& measInfo);
void write (Table&, const TableRecord& measInfo);
// </group>
// Get the name of the underlying column.
const String& columnName() const
{ return itsColumn; }
private:
String itsColumn; //# MeasValue column name.
// Write the actual keywords.
void writeKeys (TableRecord& columnKeyset,
const TableRecord& measInfo);
// Throw an exception if the quantum column doesn't exist or is of the
// wrong type.
void checkColumn (const TableDesc& td) const;
};
} //# NAMESPACE CASACORE - END
#endif
|