Loading...
Searching...
No Matches
MSFlagCmdColumns.h
Go to the documentation of this file.
//# MSFlagCmdColumns.h: provides easy access to MSFlagCmd 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_MSFLAGCMDCOLUMNS_H
#define MS_MSFLAGCMDCOLUMNS_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>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
class MSFlagCmd;
// <summary>
// A class to provide easy access to MSFlagCmd columns
// </summary>
// <use visibility=export>
// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MSFlagCmd
// <li> ScalarColumn
// </prerequisite>
//
// <etymology>
// MSFlagCmdColumns stands for MeasurementSet FlagCmd Table columns.
// </etymology>
//
// <synopsis>
// This class provides access to the columns in the MSFlagCmd Table, it does
// the declaration of all the ScalarColumns 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 MSFlagCmdColumns
{
public:
// Create a columns object that accesses the data in the specified Table
MSFlagCmdColumns(const MSFlagCmd& msFlagCmd);
// The destructor does nothing special
~MSFlagCmdColumns();
// Access to required columns
// <group>
ScalarColumn<Bool>& applied() {return applied_p;}
ScalarColumn<String>& command() {return command_p;}
ScalarColumn<Double>& interval() {return interval_p;}
ScalarQuantColumn<Double>& intervalQuant() {return intervalQuant_p;}
ScalarColumn<Int>& level() {return level_p;}
ScalarColumn<String>& reason() {return reason_p;}
ScalarColumn<Int>& severity() {return severity_p;}
ScalarColumn<Double>& time() {return time_p;}
ScalarQuantColumn<Double>& timeQuant() {return timeQuant_p;}
ScalarMeasColumn<MEpoch>& timeMeas() {return timeMeas_p;}
ScalarColumn<String>& type() {return type_p;}
// </group>
// Const access to required columns
// <group>
const ScalarColumn<Bool>& applied() const {return applied_p;}
const ScalarColumn<String>& command() const {return command_p;}
const ScalarColumn<Double>& interval() const {return interval_p;}
const ScalarQuantColumn<Double>& intervalQuant() const {return intervalQuant_p;}
const ScalarColumn<Int>& level() const {return level_p;}
const ScalarColumn<String>& reason() const {return reason_p;}
const ScalarColumn<Int>& severity() const {return severity_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;}
const ScalarColumn<String>& type() const {return type_p;}
// </group>
// Convenience function that returns the number of rows in any of the columns
rownr_t nrow() const {return applied_p.nrow();}
// set the epoch type for the FLAG_CMD 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.
MSFlagCmdColumns();
//# attach this object to the supplied table.
void attach(const MSFlagCmd& msFlagCmd);
private:
//# Make the assignment operator and the copy constructor private to prevent
//# any compiler generated one from being used.
MSFlagCmdColumns(const MSFlagCmdColumns&);
MSFlagCmdColumns& operator=(const MSFlagCmdColumns&);
//# required columns
ScalarColumn<Bool> applied_p;
ScalarColumn<String> command_p;
ScalarColumn<Double> interval_p;
ScalarColumn<Int> level_p;
ScalarColumn<String> reason_p;
ScalarColumn<Int> severity_p;
ScalarColumn<Double> time_p;
ScalarColumn<String> type_p;
//# Access to Measure columns
ScalarMeasColumn<MEpoch> timeMeas_p;
//# Access to Quantum columns
ScalarQuantColumn<Double> intervalQuant_p;
ScalarQuantColumn<Double> timeQuant_p;
};
//# Define the RO version for backward compatibility.
typedef MSFlagCmdColumns ROMSFlagCmdColumns;
} //# 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::MSFlagCmdColumns
Definition MSFlagCmdColumns.h:74
casacore::MSFlagCmdColumns::command
ScalarColumn< String > & command()
Definition MSFlagCmdColumns.h:85
casacore::MSFlagCmdColumns::command
const ScalarColumn< String > & command() const
Definition MSFlagCmdColumns.h:100
casacore::MSFlagCmdColumns::~MSFlagCmdColumns
~MSFlagCmdColumns()
The destructor does nothing special.
casacore::MSFlagCmdColumns::level_p
ScalarColumn< Int > level_p
Definition MSFlagCmdColumns.h:144
casacore::MSFlagCmdColumns::level
ScalarColumn< Int > & level()
Definition MSFlagCmdColumns.h:88
casacore::MSFlagCmdColumns::reason
ScalarColumn< String > & reason()
Definition MSFlagCmdColumns.h:89
casacore::MSFlagCmdColumns::intervalQuant
ScalarQuantColumn< Double > & intervalQuant()
Definition MSFlagCmdColumns.h:87
casacore::MSFlagCmdColumns::type_p
ScalarColumn< String > type_p
Definition MSFlagCmdColumns.h:148
casacore::MSFlagCmdColumns::timeMeas
const ScalarMeasColumn< MEpoch > & timeMeas() const
Definition MSFlagCmdColumns.h:108
casacore::MSFlagCmdColumns::reason
const ScalarColumn< String > & reason() const
Definition MSFlagCmdColumns.h:104
casacore::MSFlagCmdColumns::level
const ScalarColumn< Int > & level() const
Definition MSFlagCmdColumns.h:103
casacore::MSFlagCmdColumns::applied
ScalarColumn< Bool > & applied()
Access to required columns.
Definition MSFlagCmdColumns.h:84
casacore::MSFlagCmdColumns::type
const ScalarColumn< String > & type() const
Definition MSFlagCmdColumns.h:109
casacore::MSFlagCmdColumns::type
ScalarColumn< String > & type()
Definition MSFlagCmdColumns.h:94
casacore::MSFlagCmdColumns::time
ScalarColumn< Double > & time()
Definition MSFlagCmdColumns.h:91
casacore::MSFlagCmdColumns::severity
const ScalarColumn< Int > & severity() const
Definition MSFlagCmdColumns.h:105
casacore::MSFlagCmdColumns::timeMeas
ScalarMeasColumn< MEpoch > & timeMeas()
Definition MSFlagCmdColumns.h:93
casacore::MSFlagCmdColumns::timeQuant
const ScalarQuantColumn< Double > & timeQuant() const
Definition MSFlagCmdColumns.h:107
casacore::MSFlagCmdColumns::attach
void attach(const MSFlagCmd &msFlagCmd)
casacore::MSFlagCmdColumns::interval
const ScalarColumn< Double > & interval() const
Definition MSFlagCmdColumns.h:101
casacore::MSFlagCmdColumns::interval_p
ScalarColumn< Double > interval_p
Definition MSFlagCmdColumns.h:143
casacore::MSFlagCmdColumns::applied_p
ScalarColumn< Bool > applied_p
Definition MSFlagCmdColumns.h:141
casacore::MSFlagCmdColumns::time
const ScalarColumn< Double > & time() const
Definition MSFlagCmdColumns.h:106
casacore::MSFlagCmdColumns::time_p
ScalarColumn< Double > time_p
Definition MSFlagCmdColumns.h:147
casacore::MSFlagCmdColumns::intervalQuant_p
ScalarQuantColumn< Double > intervalQuant_p
Definition MSFlagCmdColumns.h:154
casacore::MSFlagCmdColumns::timeQuant_p
ScalarQuantColumn< Double > timeQuant_p
Definition MSFlagCmdColumns.h:155
casacore::MSFlagCmdColumns::setEpochRef
void setEpochRef(MEpoch::Types ref, Bool tableMustBeEmpty=True)
set the epoch type for the FLAG_CMD column.
casacore::MSFlagCmdColumns::timeQuant
ScalarQuantColumn< Double > & timeQuant()
Definition MSFlagCmdColumns.h:92
casacore::MSFlagCmdColumns::applied
const ScalarColumn< Bool > & applied() const
Const access to required columns.
Definition MSFlagCmdColumns.h:99
casacore::MSFlagCmdColumns::intervalQuant
const ScalarQuantColumn< Double > & intervalQuant() const
Definition MSFlagCmdColumns.h:102
casacore::MSFlagCmdColumns::reason_p
ScalarColumn< String > reason_p
Definition MSFlagCmdColumns.h:145
casacore::MSFlagCmdColumns::severity_p
ScalarColumn< Int > severity_p
Definition MSFlagCmdColumns.h:146
casacore::MSFlagCmdColumns::interval
ScalarColumn< Double > & interval()
Definition MSFlagCmdColumns.h:86
casacore::MSFlagCmdColumns::timeMeas_p
ScalarMeasColumn< MEpoch > timeMeas_p
Definition MSFlagCmdColumns.h:151
casacore::MSFlagCmdColumns::MSFlagCmdColumns
MSFlagCmdColumns(const MSFlagCmd &msFlagCmd)
Create a columns object that accesses the data in the specified Table.
casacore::MSFlagCmdColumns::command_p
ScalarColumn< String > command_p
Definition MSFlagCmdColumns.h:142
casacore::MSFlagCmdColumns::MSFlagCmdColumns
MSFlagCmdColumns()
casacore::MSFlagCmdColumns::operator=
MSFlagCmdColumns & operator=(const MSFlagCmdColumns &)
casacore::MSFlagCmdColumns::nrow
rownr_t nrow() const
Convenience function that returns the number of rows in any of the columns.
Definition MSFlagCmdColumns.h:113
casacore::MSFlagCmdColumns::severity
ScalarColumn< Int > & severity()
Definition MSFlagCmdColumns.h:90
casacore::MSFlagCmdColumns::MSFlagCmdColumns
MSFlagCmdColumns(const MSFlagCmdColumns &)
casacore::MSFlagCmd
Definition MSFlagCmd.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::ROMSFlagCmdColumns
MSFlagCmdColumns ROMSFlagCmdColumns
Definition MSFlagCmdColumns.h:159
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