Source
// Having to type long lists of Scalar and casacore::Array column declarations gets
//# CTColumns.h: provides easy access to (new) CalTable columns
//# Copyright (C) 2011
//# 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$
namespace casa { //# NAMESPACE CASA - BEGIN
class NewCalTable;
// <summary>
// A class to provide easy read-only access to new CalTable columns
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> NewCalTable
// <li> ArrayColumn
// <li> ScalarColumn
// </prerequisite>
//
// <etymology>
// ROCTColumns stands for Read-Only NewCalTable casacore::Table columns.
// </etymology>
//
// <synopsis>
// This class provides read-only access to the columns in the NewCalTable, similar
// to the casacore::MSColumns for MeasurementSet.
// 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.
// </synopsis>
//
// <example>
// <srcblock>
// // use as follows
// NewCalTable newcalt("mynewcalt");
// RONCTColumns nctc(newcalt);
// // show time from row 5
// cout << nctc.time()(5);
// // show name of antenna on row 3 in antenna table
// cout << nctc.antenna().name();
// </srcblock>
// </example>
//
// <motivation>
// See <linkto class=CTColumns> CTColumns</linkto> for the motivation.
// </motivation>
//
// <todo asof="">
// </todo>