Loading...
Searching...
No Matches
TableMeasDescBase.h
Go to the documentation of this file.
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#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
casacore::MeasureHolder
Definition MeasureHolder.h:117
casacore::Measure
Definition Measure.h:232
casacore::Quantum
Definition Quantum.h:269
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::TableColumn
Definition TableColumn.h:97
casacore::TableDesc
Definition TableDesc.h:189
casacore::TableMeasDescBase::reconstruct
static TableMeasDescBase * reconstruct(const Table &tab, const String &columnName)
Reconstructs the object for the given table and column name.
casacore::TableMeasDescBase::refType
const String & refType(uInt refCode) const
Translates the refCode for the descriptors measure type.
Definition TableMeasDescBase.h:175
casacore::TableMeasDescBase::hasMeasures
static Bool hasMeasures(const TableColumn &column)
Does this column contain table measures?
casacore::TableMeasDescBase::TableMeasDescBase
TableMeasDescBase(const TableMeasValueDesc &, const TableMeasRefDesc &)
Constructor with value and reference descriptors.
casacore::TableMeasDescBase::offsetColumnName
const String & offsetColumnName() const
Get the name of the offset column.
Definition TableMeasDescBase.h:145
casacore::TableMeasDescBase::initTabRef
void initTabRef(const MeasureHolder &measHolder)
Set the initial reference codes and types in the table.
casacore::TableMeasDescBase::resetOffset
void resetOffset(const Measure &offset)
Definition TableMeasDescBase.h:188
casacore::TableMeasDescBase::setMeasUnits
void setMeasUnits(const Measure &meas, const Vector< Quantum< Double > > &val, const Vector< Unit > &units)
Set the measure and possible units.
casacore::TableMeasDescBase::isOffsetVariable
Bool isOffsetVariable() const
Returns True if the offset is variable.
Definition TableMeasDescBase.h:153
casacore::TableMeasDescBase::clone
virtual TableMeasDescBase * clone() const
Clone the object.
casacore::TableMeasDescBase::itsMeasType
TableMeasType itsMeasType
Definition TableMeasDescBase.h:213
casacore::TableMeasDescBase::getUnits
const Vector< Unit > & getUnits() const
Return the Units of the Measure values.
Definition TableMeasDescBase.h:179
casacore::TableMeasDescBase::refColumnName
const String & refColumnName() const
Returns the name of the ref code column when the ref code is variable.
Definition TableMeasDescBase.h:136
casacore::TableMeasDescBase::getOffset
const Measure & getOffset() const
Returns a reference to the offset.
Definition TableMeasDescBase.h:162
casacore::TableMeasDescBase::TableMeasDescBase
TableMeasDescBase()
Null constructor.
casacore::TableMeasDescBase::getRefDesc
const TableMeasRefDesc & getRefDesc() const
Returns a reference to its measure reference descriptor.
Definition TableMeasDescBase.h:140
casacore::TableMeasDescBase::hasOffset
Bool hasOffset() const
Returns True if an offset has been defined.
Definition TableMeasDescBase.h:149
casacore::TableMeasDescBase::write
void write(TableDesc &)
Makes the descriptor persistent.
casacore::TableMeasDescBase::resetRefCode
void resetRefCode(uInt refCode)
Reset the refCode, offset, or units.
Definition TableMeasDescBase.h:186
casacore::TableMeasDescBase::itsRef
TableMeasRefDesc itsRef
Definition TableMeasDescBase.h:211
casacore::TableMeasDescBase::columnName
const String & columnName() const
Get the name of the underlying column.
Definition TableMeasDescBase.h:123
casacore::TableMeasDescBase::TableMeasDescBase
TableMeasDescBase(const TableMeasDescBase &that)
Copy constructor.
casacore::TableMeasDescBase::isRefCodeVariable
Bool isRefCodeVariable() const
Returns True if the reference varies per row.
Definition TableMeasDescBase.h:131
casacore::TableMeasDescBase::operator=
TableMeasDescBase & operator=(const TableMeasDescBase &that)
Assignment operator.
casacore::TableMeasDescBase::itsValue
TableMeasValueDesc itsValue
Definition TableMeasDescBase.h:210
casacore::TableMeasDescBase::itsUnits
Vector< Unit > itsUnits
Definition TableMeasDescBase.h:214
casacore::TableMeasDescBase::write
void write(Table &)
casacore::TableMeasDescBase::isOffsetArray
Bool isOffsetArray() const
Returns True if the offset is variable and is stored in an ArrayMeasColumn, i.e., offsets are stored ...
Definition TableMeasDescBase.h:158
casacore::TableMeasDescBase::type
const String & type() const
Returns the descriptors measure type as a String.
Definition TableMeasDescBase.h:166
casacore::TableMeasDescBase::refCode
uInt refCode(const String &refString) const
Returns the reference code for this object given a string.
Definition TableMeasDescBase.h:171
casacore::TableMeasDescBase::~TableMeasDescBase
virtual ~TableMeasDescBase()
casacore::TableMeasDescBase::writeIfOld
void writeIfOld(const Table &)
Make the descriptor persistent if there was no refcode vector.
casacore::TableMeasDescBase::getRefCode
uInt getRefCode() const
Return the reference code.
Definition TableMeasDescBase.h:127
casacore::TableMeasDescBase::resetUnits
void resetUnits(const Vector< Unit > &units)
casacore::TableMeasRefDesc
Definition TableMeasRefDesc.h:166
casacore::TableMeasType
Definition TableMeasType.h:84
casacore::TableMeasValueDesc
Definition TableMeasValueDesc.h:106
casacore::TableRecord
Definition TableRecord.h:183
casacore::Table
Definition Table.h:157
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::offset
int offset(int, int) const
compute a linear offset from array indicies
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40