Line data    Source code

       1             : //# CalIterBase.h: Base class for calibration table iterators
       2             : //# Copyright (C) 1996,1997,1998,2001,2002,2003
       3             : //# Associated Universities, Inc. Washington DC, USA.
       4             : //#
       5             : //# This library is free software; you can redistribute it and/or modify it
       6             : //# under the terms of the GNU Library General Public License as published by
       7             : //# the Free Software Foundation; either version 2 of the License, or (at your
       8             : //# option) any later version.
       9             : //#
      10             : //# This library is distributed in the hope that it will be useful, but WITHOUT
      11             : //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
      12             : //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
      13             : //# License for more details.
      14             : //#
      15             : //# You should have received a copy of the GNU Library General Public License
      16             : //# along with this library; if not, write to the Free Software Foundation,
      17             : //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
      18             : //#
      19             : //# Correspondence concerning AIPS++ should be adressed as follows:
      20             : //#        Internet email: aips2-request@nrao.edu.
      21             : //#        Postal address: AIPS++ Project Office
      22             : //#                        National Radio Astronomy Observatory
      23             : //#                        520 Edgemont Road
      24             : //#                        Charlottesville, VA 22903-2475 USA
      25             : //#
      26             : //#
      27             : //# $Id$
      28             : 
      29             : #ifndef CALIBRATION_CALITERBASE_H
      30             : #define CALIBRATION_CALITERBASE_H
      31             : 
      32             : #include <casacore/casa/aips.h>
      33             : #include <synthesis/CalTables/CalTable.h>
      34             : 
      35             : 
      36             : namespace casa { //# NAMESPACE CASA - BEGIN
      37             : 
      38             : // <summary> 
      39             : // CalIterBase: Base class for calibration table iterators
      40             : // </summary>
      41             : 
      42             : // <use visibility=export>
      43             : 
      44             : // <reviewed reviewer="" date="" tests="" demos="">
      45             : 
      46             : // <prerequisite>
      47             : //   <li> <linkto class="CalTable">CalTable</linkto> module
      48             : // </prerequisite>
      49             : //
      50             : // <etymology>
      51             : // From "calibration table iterator" and "base class"
      52             : // </etymology>
      53             : //
      54             : // <synopsis>
      55             : // The CalIterBase class is an abstract base class defining
      56             : // the common fundamental interface for different types of
      57             : // calibration table iterators. Specializations include
      58             : // sequential and indexed iterators.
      59             : // </synopsis>
      60             : //
      61             : // <example>
      62             : // <srcblock>
      63             : // </srcblock>
      64             : // </example>
      65             : //
      66             : // <motivation>
      67             : // Provide an abstract base class for all calibration table iterators
      68             : // </motivation>
      69             : //
      70             : // <todo asof="01/08/01">
      71             : // (i) Deal with non-standard columns.
      72             : // </todo>
      73             : 
      74             : class CalIterBase 
      75             : {
      76             :  public:
      77             :   // Default destructor
      78           0 :   virtual ~CalIterBase() {};
      79             : 
      80             :   // Current iteration sub-table
      81             :   virtual CalTable& subTable() = 0;
      82             : 
      83             :  protected:
      84             :   // Prohibit public use of the null constructor, which
      85             :   // does not produce a usable object.
      86           0 :   CalIterBase() {};
      87             : 
      88             :  private:
      89             : 
      90             : };
      91             : 
      92             : 
      93             : } //# NAMESPACE CASA - END
      94             : 
      95             : #endif
      96             :    
      97             :   
      98             : 
      99             : 
     100             :