casa::MSState Class Reference

A Table intended to hold a MeasurementSet STATE table. More...

#include <MSState.h>

Inheritance diagram for casa::MSState:

List of all members.

Public Member Functions
	MSState ()
	This constructs an empty MSState.
	~MSState ()
	As with tables, the destructor writes the table if necessary.
MSState &	operator= (const MSState &)
	Assignment operator, reference semantics.
MSState	referenceCopy (const String &newTableName, const Block< String > &writableColumns) const
	Make a special copy of this Table which references all columns from this Table except those mentioned; those are empty and writable.
	MSState (const String &tableName, TableOption=Table::Old)
	These constructors mirror the Table ones with additional checking on validity (verifying that the MSState will have the required columns and keywords).
	MSState (const String &tableName, const String &tableDescName, TableOption=Table::Old)
	MSState (SetupNewTable &newTab, uInt nrrow=0, Bool initialize=False)
	MSState (const Table &table)
	MSState (const MSState &other)
Static Public Member Functions
static void	init ()
	Initialize the statics appropriately.
Private Attributes
Bool	hasBeenDestroyed_p
	required by the need to throw an exception in the destructor

---

Detailed Description

A Table intended to hold a MeasurementSet STATE table.

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MeasurementSet
• MSTable

Etymology

MSState stands for the MeasurementSet State table.

Synopsis

An MSState is a table intended to hold the STATE table for the MeasurementSet. It has an identical set of member functions as the main MeasurementSet class, except (currently) for the default calibration members. For further info and examples see the MeasurementSet class.

Example

See the MeasurementSet for an example of how to access and use this class.

Motivation

It was found that subtables and the main table of the MeasurementSet have a lot in common, therefore they derive their interface from the same base class. Each subtable has its own class to keep the enum definitions and conversion functions in separate scopes.

Definition at line 79 of file MSState.h.

---

Constructor & Destructor Documentation

casa::MSState::MSState

(

)

This constructs an empty MSState.

casa::MSState::MSState	(	const String &	tableName,
		TableOption	= Table::Old
	)

These constructors mirror the Table ones with additional checking on validity (verifying that the MSState will have the required columns and keywords).

   An exception is thrown if the constructed Table is not a valid MSState

  <h3>Thrown Exceptions</h3><ul>    <li> AipsError
  </ul>

casa::MSState::MSState	(	const String &	tableName,
		const String &	tableDescName,
		TableOption	= Table::Old
	)

casa::MSState::MSState	(	SetupNewTable &	newTab,
		uInt	nrrow = 0,
		Bool	initialize = False
	)

casa::MSState::MSState

(

const Table &

table

)

casa::MSState::MSState

(

const MSState &

other

)

casa::MSState::~MSState

(

)

As with tables, the destructor writes the table if necessary.

Additional checking is done here to verify that all required columns are still present. If it is NOT valid, it will write the table and then throw an exception.

Thrown Exceptions

• AipsError

---

Member Function Documentation

static void casa::MSState::init

(

)

[static]

Initialize the statics appropriately.

This does not need to be called by users, it is called by the implementation class MSTableImpl.

MSState& casa::MSState::operator=

(

const MSState &

)

Assignment operator, reference semantics.

MSState casa::MSState::referenceCopy	(	const String &	newTableName,
		const Block< String > &	writableColumns
	)		const

Make a special copy of this Table which references all columns from this Table except those mentioned; those are empty and writable.

Each forwarded column has the same writable status as the underlying column. The mentioned columns all use the AipsIO storage manager. This function is inherited from MSTable and unlikely to be of use, except in the class MeasurementSet (see comment there)..

Reimplemented from casa::MSTable< MSStateEnums::PredefinedColumns, MSStateEnums::PredefinedKeywords >.

---

Member Data Documentation

Bool casa::MSState::hasBeenDestroyed_p [private]

required by the need to throw an exception in the destructor

Definition at line 133 of file MSState.h.

---

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

• casacore/ms/MeasurementSets/MSState.h