MSField.h

Go to the documentation of this file.

//# MSField.h: The MeasurementSet FIELD Table
//# Copyright (C) 1996,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: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id: MSField.h 20299 2008-04-03 05:56:44Z gervandiepen $

#ifndef MS_MSFIELD_H
#define MS_MSFIELD_H

#include <casa/aips.h>
#include <ms/MeasurementSets/MSTable.h>
#include <ms/MeasurementSets/MSFieldEnums.h>

namespace casa { //# NAMESPACE CASA - BEGIN

// <summary> 
// A Table intended to hold a MeasurementSet FIELD table.
// </summary>

// <use visibility=export>

// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">

// <prerequisite>
//   <li> <linkto class="MeasurementSet:description">MeasurementSet</linkto> 
//   <li> <linkto class="MSTable">MSTable</linkto> 
// </prerequisite>
//
// <etymology>
// MSField stands for the MeasurementSet Field table.
// </etymology>
//
// <synopsis> 
// An MSField is a table intended to hold the FIELD 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.
// </synopsis> 
//
// <example>
// See the MeasurementSet for an example of how to access and use this class.
// </example>
//
// <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.
// </motivation>
//
// <todo asof="1999/01/13">
// see MeasurementSet.
// </todo>

class MSField:public MSFieldEnums,
                public MSTable<MSFieldEnums::PredefinedColumns,
                               MSFieldEnums::PredefinedKeywords>
{
public:

    // This constructs an empty MSField.
    MSField ();

    // These constructors mirror the Table ones with additional checking
    // on validity (verifying that the MSField will have the required columns
    // and keywords)
    // An exception is thrown if the constructed Table is not a valid MSField
    // <thrown>
    //   <li> AipsError
    // </thrown>
    // <group name=tableLikeConstructors>
    MSField (const String &tableName, TableOption = Table::Old);
    MSField (const String &tableName, const String &tableDescName,
                    TableOption = Table::Old);
    MSField (SetupNewTable &newTab, uInt nrrow = 0,
                    Bool initialize = False);
    MSField (const Table &table);
    MSField (const MSField &other);
    // </group>

    // 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>
    //   <li> AipsError
    // </thrown>
    ~MSField();

    //  Assignment operator, reference semantics
    MSField& operator=(const MSField&);

    // 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)..
    MSField referenceCopy(const String& newTableName,
                          const Block<String>& writableColumns) const;

    // Add an ephemeris table (there can be many) to the Field table.
    // The table is copied from inputEphemTableName and named
    // EPHEM<id>_<comment>.tab
    // If any tables of the same id exist already, they are removed beforehand.
    // The optional EPHEMERIS_ID column is added if it doesn't exist, yet.
    // Return False in case of errors.
    Bool addEphemeris(const uInt id, const String& inputEphemTableName,
                      const String& comment);

    // Remove (delete) any ephemeris tables with given id (without changes to
    // the EPHEMERIS_ID column).
    // Return False in case of errors (but True if the id didn't exist).
    Bool removeEphemeris(const uInt id);

    // Initialize the statics appropriately. This does not need to be
    // called by users, it is called by the implementation class
    // MSTableImpl.
    static void init();

private:

    // required by the need to throw an exception in the destructor
    Bool hasBeenDestroyed_p;
};


} //# NAMESPACE CASA - END

#endif