A class to provide easy read-write access to MSFlagCmd columns. More...

#include <MSFlagCmdColumns.h>

Inheritance diagram for casacore::MSFlagCmdColumns:

Public Member Functions
	MSFlagCmdColumns (MSFlagCmd &msFlagCmd)
	Create a columns object that accesses the data in the specified Table. More...

	~MSFlagCmdColumns ()
	The destructor does nothing special. More...

ScalarColumn< Bool > &	applied ()
	Read-write access to required columns. More...

ScalarColumn< String > &	command ()

ScalarColumn< Double > &	interval ()

ScalarQuantColumn< Double > &	intervalQuant ()

ScalarColumn< Int > &	level ()

ScalarColumn< String > &	reason ()

ScalarColumn< Int > &	severity ()

ScalarColumn< Double > &	time ()

ScalarQuantColumn< Double > &	timeQuant ()

ScalarMeasColumn< MEpoch > &	timeMeas ()

ScalarColumn< String > &	type ()

const ROScalarColumn< Bool > &	applied () const
	Read-only access to required columns. More...

const ROScalarColumn< String > &	command () const

const ROScalarQuantColumn < Double > &	intervalQuant () const

const ROScalarColumn< Double > &	interval () const

const ROScalarColumn< Int > &	level () const

const ROScalarColumn< String > &	reason () const

const ROScalarColumn< Int > &	severity () const

const ROScalarColumn< Double > &	time () const

const ROScalarQuantColumn < Double > &	timeQuant () const

const ROScalarMeasColumn < MEpoch > &	timeMeas () const

const ROScalarColumn< String > &	type () const

void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the FLAG_CMD column. More...

Public Member Functions inherited from casacore::ROMSFlagCmdColumns
	ROMSFlagCmdColumns (const MSFlagCmd &msFlagCmd)
	Create a columns object that accesses the data in the specified Table. More...

	~ROMSFlagCmdColumns ()
	The destructor does nothing special. More...

const ROScalarColumn< Bool > &	applied () const
	Access to required columns. More...

const ROScalarColumn< String > &	command () const

const ROScalarQuantColumn < Double > &	intervalQuant () const

const ROScalarColumn< Double > &	interval () const

const ROScalarColumn< Int > &	level () const

const ROScalarColumn< String > &	reason () const

const ROScalarColumn< Int > &	severity () const

const ROScalarColumn< Double > &	time () const

const ROScalarQuantColumn < Double > &	timeQuant () const

const ROScalarMeasColumn < MEpoch > &	timeMeas () const

const ROScalarColumn< String > &	type () const

uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...

Protected Member Functions
	MSFlagCmdColumns ()

void	attach (MSFlagCmd &msFlagCmd)

Protected Member Functions inherited from casacore::ROMSFlagCmdColumns
	ROMSFlagCmdColumns ()

void	attach (const MSFlagCmd &msFlagCmd)

Private Member Functions
	MSFlagCmdColumns (const MSFlagCmdColumns &)

MSFlagCmdColumns &	operator= (const MSFlagCmdColumns &)

Private Attributes
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

ScalarMeasColumn< MEpoch >	timeMeas_p

ScalarQuantColumn< Double >	intervalQuant_p

ScalarQuantColumn< Double >	timeQuant_p

Detailed Description

A class to provide easy read-write access to MSFlagCmd columns.

Intended use:

Public interface

Review Status

Reviewed By:: Bob Garwood
Date Reviewed:: 1997/02/01

Prerequisite

Etymology

MSFlagCmdColumns stands for MeasurementSet FlagCmd Table columns.

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 MSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 167 of file MSFlagCmdColumns.h.

Constructor & Destructor Documentation

casacore::MSFlagCmdColumns::MSFlagCmdColumns ( MSFlagCmd & msFlagCmd )

Create a columns object that accesses the data in the specified Table.

casacore::MSFlagCmdColumns::~MSFlagCmdColumns ( )

The destructor does nothing special.

casacore::MSFlagCmdColumns::MSFlagCmdColumns ( )

protected

casacore::MSFlagCmdColumns::MSFlagCmdColumns ( const MSFlagCmdColumns & )

private

Member Function Documentation

ScalarColumn<Bool>& casacore::MSFlagCmdColumns::applied ( )

inline

Read-write access to required columns.

Definition at line 178 of file MSFlagCmdColumns.h.

References applied_p.

const ROScalarColumn<Bool>& casacore::MSFlagCmdColumns::applied ( ) const

inline

Read-only access to required columns.

Definition at line 193 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::applied().

void casacore::MSFlagCmdColumns::attach ( MSFlagCmd & msFlagCmd )

protected

ScalarColumn<String>& casacore::MSFlagCmdColumns::command ( )

inline

Definition at line 179 of file MSFlagCmdColumns.h.

References command_p.

const ROScalarColumn<String>& casacore::MSFlagCmdColumns::command ( ) const

inline

Definition at line 195 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::command().

ScalarColumn<Double>& casacore::MSFlagCmdColumns::interval ( )

inline

Definition at line 180 of file MSFlagCmdColumns.h.

References interval_p.

const ROScalarColumn<Double>& casacore::MSFlagCmdColumns::interval ( ) const

inline

Definition at line 199 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::interval().

ScalarQuantColumn<Double>& casacore::MSFlagCmdColumns::intervalQuant ( )

inline

Definition at line 181 of file MSFlagCmdColumns.h.

References intervalQuant_p.

const ROScalarQuantColumn<Double>& casacore::MSFlagCmdColumns::intervalQuant ( ) const

inline

Definition at line 197 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::intervalQuant().

ScalarColumn<Int>& casacore::MSFlagCmdColumns::level ( )

inline

Definition at line 182 of file MSFlagCmdColumns.h.

References level_p.

const ROScalarColumn<Int>& casacore::MSFlagCmdColumns::level ( ) const

inline

Definition at line 201 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::level().

MSFlagCmdColumns& casacore::MSFlagCmdColumns::operator= ( const MSFlagCmdColumns & )

private

ScalarColumn<String>& casacore::MSFlagCmdColumns::reason ( )

inline

Definition at line 183 of file MSFlagCmdColumns.h.

References reason_p.

const ROScalarColumn<String>& casacore::MSFlagCmdColumns::reason ( ) const

inline

Definition at line 203 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::reason().

void casacore::MSFlagCmdColumns::setEpochRef	(	MEpoch::Types	ref,
		Bool	tableMustBeEmpty = `True`
	)

set the epoch type for the FLAG_CMD column.

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 tableMustBeEmpty argument;

ScalarColumn<Int>& casacore::MSFlagCmdColumns::severity ( )

inline

Definition at line 184 of file MSFlagCmdColumns.h.

References severity_p.

const ROScalarColumn<Int>& casacore::MSFlagCmdColumns::severity ( ) const

inline

Definition at line 205 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::severity().

ScalarColumn<Double>& casacore::MSFlagCmdColumns::time ( void )

inline

Definition at line 185 of file MSFlagCmdColumns.h.

References time_p.

const ROScalarColumn<Double>& casacore::MSFlagCmdColumns::time ( void ) const

inline

Definition at line 207 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::time().

ScalarMeasColumn<MEpoch>& casacore::MSFlagCmdColumns::timeMeas ( )

inline

Definition at line 187 of file MSFlagCmdColumns.h.

References timeMeas_p.

const ROScalarMeasColumn<MEpoch>& casacore::MSFlagCmdColumns::timeMeas ( ) const

inline

Definition at line 211 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::timeMeas().

ScalarQuantColumn<Double>& casacore::MSFlagCmdColumns::timeQuant ( )

inline

Definition at line 186 of file MSFlagCmdColumns.h.

References timeQuant_p.

const ROScalarQuantColumn<Double>& casacore::MSFlagCmdColumns::timeQuant ( ) const

inline

Definition at line 209 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::timeQuant().

ScalarColumn<String>& casacore::MSFlagCmdColumns::type ( )

inline

Definition at line 188 of file MSFlagCmdColumns.h.

References type_p.

const ROScalarColumn<String>& casacore::MSFlagCmdColumns::type ( ) const

inline

Definition at line 213 of file MSFlagCmdColumns.h.

References casacore::ROMSFlagCmdColumns::type().

Member Data Documentation

ScalarColumn<Bool> casacore::MSFlagCmdColumns::applied_p

private

Definition at line 243 of file MSFlagCmdColumns.h.

Referenced by applied().

ScalarColumn<String> casacore::MSFlagCmdColumns::command_p

private

Definition at line 244 of file MSFlagCmdColumns.h.

Referenced by command().

ScalarColumn<Double> casacore::MSFlagCmdColumns::interval_p

private

Definition at line 245 of file MSFlagCmdColumns.h.

Referenced by interval().

ScalarQuantColumn<Double> casacore::MSFlagCmdColumns::intervalQuant_p

private

Definition at line 256 of file MSFlagCmdColumns.h.

Referenced by intervalQuant().

ScalarColumn<Int> casacore::MSFlagCmdColumns::level_p

private

Definition at line 246 of file MSFlagCmdColumns.h.

Referenced by level().

ScalarColumn<String> casacore::MSFlagCmdColumns::reason_p

private

Definition at line 247 of file MSFlagCmdColumns.h.

Referenced by reason().

ScalarColumn<Int> casacore::MSFlagCmdColumns::severity_p

private

Definition at line 248 of file MSFlagCmdColumns.h.

Referenced by severity().

ScalarColumn<Double> casacore::MSFlagCmdColumns::time_p

private

Definition at line 249 of file MSFlagCmdColumns.h.

Referenced by time().

ScalarMeasColumn<MEpoch> casacore::MSFlagCmdColumns::timeMeas_p

private

Definition at line 253 of file MSFlagCmdColumns.h.

Referenced by timeMeas().

ScalarQuantColumn<Double> casacore::MSFlagCmdColumns::timeQuant_p

private

Definition at line 257 of file MSFlagCmdColumns.h.

Referenced by timeQuant().

ScalarColumn<String> casacore::MSFlagCmdColumns::type_p

private

Definition at line 250 of file MSFlagCmdColumns.h.

Referenced by type().

The documentation for this class was generated from the following file:

casa/casacore/ms/MeasurementSets/MSFlagCmdColumns.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation