Loading...
Searching...
No Matches
MSFreqOffColumns.h
Go to the documentation of this file.
//# MSFreqOffsetColumns.h: provides easy access to FREQ_OFFSET columns
//# Copyright (C) 1999,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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MS_MSFREQOFFCOLUMNS_H
#define MS_MSFREQOFFCOLUMNS_H
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MEpoch.h>
#include <casacore/measures/Measures/MCEpoch.h>
#include <casacore/measures/TableMeasures/ScalarMeasColumn.h>
#include <casacore/measures/TableMeasures/ScalarQuantColumn.h>
#include <casacore/tables/Tables/ScalarColumn.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
class MSFreqOffset;
// <summary>
// A class to provide easy access to MSFreqOffset columns
// </summary>
// <use visibility=export>
// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MSFreqOffset
// <li> ScalarColumn
// </prerequisite>
//
// <etymology>
// MSFreqOffsetColumns stands for MeasurementSet FreqOffset Table
// columns.
// </etymology>
//
// <synopsis>
// This class provides access to the columns in the MSFreqOffset Table,
// it does the declaration of all the Scalar and ArrayColumns with the
// correct types, so the application programmer doesn't have to
// worry about getting those right. There is an access function
// for every predefined column. Access to non-predefined columns will still
// have to be done with explicit declarations.
// See <linkto class=MSColumns> MSColumns</linkto> for an example.
// </synopsis>
//
// <motivation>
// See <linkto class=MSColumns> MSColumns</linkto> for the motivation.
// </motivation>
class MSFreqOffsetColumns
{
public:
// Create a columns object that accesses the data in the specified Table
MSFreqOffsetColumns(const MSFreqOffset& msFreqOffset);
// The destructor does nothing special
~MSFreqOffsetColumns();
// Is this object defined? (MSFreqOffset table is optional)
Bool isNull() const {return isNull_p;}
// Access to required columns
// <group>
ScalarColumn<Int>& antenna1() {return antenna1_p;}
ScalarColumn<Int>& antenna2() {return antenna2_p;}
ScalarColumn<Int>& feedId() {return feedId_p;}
ScalarColumn<Double>& interval() {return interval_p;}
ScalarQuantColumn<Double>& intervalQuant() {return intervalQuant_p;}
ScalarColumn<Double>& offset() {return offset_p;}
ScalarQuantColumn<Double>& offsetQuant() {return offsetQuant_p;}
ScalarColumn<Int>& spectralWindowId() {return spectralWindowId_p;}
ScalarColumn<Double>& time() {return time_p;}
ScalarQuantColumn<Double>& timeQuant() {return timeQuant_p;}
ScalarMeasColumn<MEpoch>& timeMeas() {return timeMeas_p;}
// </group>
// Const access to required columns
// <group>
const ScalarColumn<Int>& antenna1() const {return antenna1_p;}
const ScalarColumn<Int>& antenna2() const {return antenna2_p;}
const ScalarColumn<Int>& feedId() const {return feedId_p;}
const ScalarColumn<Double>& interval() const {return interval_p;}
const ScalarQuantColumn<Double>& intervalQuant() const {return intervalQuant_p;}
const ScalarColumn<Double>& offset() const {return offset_p;}
const ScalarQuantColumn<Double>& offsetQuant() const {return offsetQuant_p;}
const ScalarColumn<Int>& spectralWindowId() const {return spectralWindowId_p;}
const ScalarColumn<Double>& time() const {return time_p;}
const ScalarQuantColumn<Double>& timeQuant() const {return timeQuant_p;}
const ScalarMeasColumn<MEpoch>& timeMeas() const {return timeMeas_p;}
// </group>
// Convenience function that returns the number of rows in any of the
// columns. Returns zero if the object is null.
rownr_t nrow() const {return isNull() ? 0 : antenna1_p.nrow();}
// set the epoch type for the TIME column.
// <note role=tip>
// In principle this function can only be used if the table is empty,
// otherwise already written values may thereafter have an incorrect
// reference, offset, or unit. However, it is possible that part of the
// table gets written before these values are known. In that case the
// reference, offset, or units can be set by using a False
// <src>tableMustBeEmpty</src> argument.
// </note>
void setEpochRef(MEpoch::Types ref, Bool tableMustBeEmpty=True);
protected:
//# default constructor creates a object that is not usable. Use the attach
//# function correct this.
MSFreqOffsetColumns();
//# attach this object to the supplied table.
void attach(const MSFreqOffset& msFreqOffset);
private:
//# Make the assignment operator and the copy constructor private to prevent
//# any compiler generated one from being used.
MSFreqOffsetColumns(const MSFreqOffsetColumns&);
MSFreqOffsetColumns& operator=(const MSFreqOffsetColumns&);
//# Is the object not attached to a Table.
Bool isNull_p;
//# required columns
ScalarColumn<Int> antenna1_p;
ScalarColumn<Int> antenna2_p;
ScalarColumn<Int> feedId_p;
ScalarColumn<Double> interval_p;
ScalarColumn<Double> offset_p;
ScalarColumn<Int> spectralWindowId_p;
ScalarColumn<Double> time_p;
//# Access to Measure columns
ScalarMeasColumn<MEpoch> timeMeas_p;
//# Access to Quantum columns
ScalarQuantColumn<Double> intervalQuant_p;
ScalarQuantColumn<Double> offsetQuant_p;
ScalarQuantColumn<Double> timeQuant_p;
};
//# Define the RO version for backward compatibility.
typedef MSFreqOffsetColumns ROMSFreqOffsetColumns;
} //# NAMESPACE CASACORE - END
#endif
casacore::MEpoch::Types
Types
Types of known MEpochs Caution: The order defines the order in the translation matrix in the MCEpoch...
Definition MEpoch.h:114
casacore::MSFreqOffsetColumns
Definition MSFreqOffColumns.h:74
casacore::MSFreqOffsetColumns::nrow
rownr_t nrow() const
Convenience function that returns the number of rows in any of the columns.
Definition MSFreqOffColumns.h:117
casacore::MSFreqOffsetColumns::feedId
const ScalarColumn< Int > & feedId() const
Definition MSFreqOffColumns.h:104
casacore::MSFreqOffsetColumns::time
ScalarColumn< Double > & time()
Definition MSFreqOffColumns.h:95
casacore::MSFreqOffsetColumns::timeQuant
const ScalarQuantColumn< Double > & timeQuant() const
Definition MSFreqOffColumns.h:111
casacore::MSFreqOffsetColumns::offset_p
ScalarColumn< Double > offset_p
Definition MSFreqOffColumns.h:152
casacore::MSFreqOffsetColumns::feedId_p
ScalarColumn< Int > feedId_p
Definition MSFreqOffColumns.h:150
casacore::MSFreqOffsetColumns::interval
const ScalarColumn< Double > & interval() const
Definition MSFreqOffColumns.h:105
casacore::MSFreqOffsetColumns::antenna1
ScalarColumn< Int > & antenna1()
Access to required columns.
Definition MSFreqOffColumns.h:87
casacore::MSFreqOffsetColumns::intervalQuant
ScalarQuantColumn< Double > & intervalQuant()
Definition MSFreqOffColumns.h:91
casacore::MSFreqOffsetColumns::MSFreqOffsetColumns
MSFreqOffsetColumns()
casacore::MSFreqOffsetColumns::interval
ScalarColumn< Double > & interval()
Definition MSFreqOffColumns.h:90
casacore::MSFreqOffsetColumns::timeMeas
const ScalarMeasColumn< MEpoch > & timeMeas() const
Definition MSFreqOffColumns.h:112
casacore::MSFreqOffsetColumns::timeQuant
ScalarQuantColumn< Double > & timeQuant()
Definition MSFreqOffColumns.h:96
casacore::MSFreqOffsetColumns::timeQuant_p
ScalarQuantColumn< Double > timeQuant_p
Definition MSFreqOffColumns.h:162
casacore::MSFreqOffsetColumns::offset
const ScalarColumn< Double > & offset() const
Definition MSFreqOffColumns.h:107
casacore::MSFreqOffsetColumns::feedId
ScalarColumn< Int > & feedId()
Definition MSFreqOffColumns.h:89
casacore::MSFreqOffsetColumns::antenna1_p
ScalarColumn< Int > antenna1_p
Definition MSFreqOffColumns.h:148
casacore::MSFreqOffsetColumns::spectralWindowId_p
ScalarColumn< Int > spectralWindowId_p
Definition MSFreqOffColumns.h:153
casacore::MSFreqOffsetColumns::offsetQuant
ScalarQuantColumn< Double > & offsetQuant()
Definition MSFreqOffColumns.h:93
casacore::MSFreqOffsetColumns::MSFreqOffsetColumns
MSFreqOffsetColumns(const MSFreqOffset &msFreqOffset)
Create a columns object that accesses the data in the specified Table.
casacore::MSFreqOffsetColumns::isNull_p
Bool isNull_p
Definition MSFreqOffColumns.h:145
casacore::MSFreqOffsetColumns::offset
ScalarColumn< Double > & offset()
Definition MSFreqOffColumns.h:92
casacore::MSFreqOffsetColumns::timeMeas_p
ScalarMeasColumn< MEpoch > timeMeas_p
Definition MSFreqOffColumns.h:157
casacore::MSFreqOffsetColumns::intervalQuant
const ScalarQuantColumn< Double > & intervalQuant() const
Definition MSFreqOffColumns.h:106
casacore::MSFreqOffsetColumns::MSFreqOffsetColumns
MSFreqOffsetColumns(const MSFreqOffsetColumns &)
casacore::MSFreqOffsetColumns::antenna2
ScalarColumn< Int > & antenna2()
Definition MSFreqOffColumns.h:88
casacore::MSFreqOffsetColumns::time
const ScalarColumn< Double > & time() const
Definition MSFreqOffColumns.h:110
casacore::MSFreqOffsetColumns::spectralWindowId
ScalarColumn< Int > & spectralWindowId()
Definition MSFreqOffColumns.h:94
casacore::MSFreqOffsetColumns::interval_p
ScalarColumn< Double > interval_p
Definition MSFreqOffColumns.h:151
casacore::MSFreqOffsetColumns::antenna2_p
ScalarColumn< Int > antenna2_p
Definition MSFreqOffColumns.h:149
casacore::MSFreqOffsetColumns::offsetQuant
const ScalarQuantColumn< Double > & offsetQuant() const
Definition MSFreqOffColumns.h:108
casacore::MSFreqOffsetColumns::antenna1
const ScalarColumn< Int > & antenna1() const
Const access to required columns.
Definition MSFreqOffColumns.h:102
casacore::MSFreqOffsetColumns::setEpochRef
void setEpochRef(MEpoch::Types ref, Bool tableMustBeEmpty=True)
set the epoch type for the TIME column.
casacore::MSFreqOffsetColumns::antenna2
const ScalarColumn< Int > & antenna2() const
Definition MSFreqOffColumns.h:103
casacore::MSFreqOffsetColumns::offsetQuant_p
ScalarQuantColumn< Double > offsetQuant_p
Definition MSFreqOffColumns.h:161
casacore::MSFreqOffsetColumns::isNull
Bool isNull() const
Is this object defined?
Definition MSFreqOffColumns.h:83
casacore::MSFreqOffsetColumns::intervalQuant_p
ScalarQuantColumn< Double > intervalQuant_p
Definition MSFreqOffColumns.h:160
casacore::MSFreqOffsetColumns::~MSFreqOffsetColumns
~MSFreqOffsetColumns()
The destructor does nothing special.
casacore::MSFreqOffsetColumns::attach
void attach(const MSFreqOffset &msFreqOffset)
casacore::MSFreqOffsetColumns::spectralWindowId
const ScalarColumn< Int > & spectralWindowId() const
Definition MSFreqOffColumns.h:109
casacore::MSFreqOffsetColumns::operator=
MSFreqOffsetColumns & operator=(const MSFreqOffsetColumns &)
casacore::MSFreqOffsetColumns::time_p
ScalarColumn< Double > time_p
Definition MSFreqOffColumns.h:154
casacore::MSFreqOffsetColumns::timeMeas
ScalarMeasColumn< MEpoch > & timeMeas()
Definition MSFreqOffColumns.h:97
casacore::MSFreqOffset
Definition MSFreqOffset.h:77
casacore::ScalarColumn
Definition ScalarColumn.h:83
casacore::ScalarMeasColumn
Definition ScalarMeasColumn.h:141
casacore::ScalarQuantColumn
Definition ScalarQuantColumn.h:118
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::ref
const RecordRep & ref() const
Return a const reference to the underlying RecordRep.
casacore::ROMSFreqOffsetColumns
MSFreqOffsetColumns ROMSFreqOffsetColumns
Definition MSFreqOffColumns.h:166
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::True
const Bool True
Definition aipstype.h:41
casacore::rownr_t
uInt64 rownr_t
Define the type of a row number in a table.
Definition aipsxtype.h:44