LogiArrayFwd.h

Go to the documentation of this file.
00001 //# LogiArrayFwd.h: Forwards for LogicalArrays.
00002 //# Copyright (C) 1994,1995,1999
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id$
00027 
00028 #ifndef CASA_LOGIARRAYFWD_H
00029 #define CASA_LOGIARRAYFWD_H
00030 
00031 
00032 #include <casacore/casa/aips.h>
00033 
00034 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00035 
00036 // <summary>
00037 //    Forward declarations for LogicalArrays.
00038 // </summary>
00039 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
00040 //
00041 // <prerequisite>
00042 //   <li> <linkto class=Array>Array</linkto>
00043 //   <li> <linkto group="LogiArray.h#LogicalArray">LogicalArray</linkto>
00044 // </prerequisite>
00045 //
00046 // <etymology>
00047 // LogiArrayFwd is short for LogicalArrayForwards, which was too long by
00048 // the old AIPS++ file naming conventions.
00049 // It contains forwards for LogicalArrays.
00050 // </etymology>
00051 //
00052 // <synopsis>
00053 // This file contains forward definitions for LogicalArrays.
00054 // </synopsis>
00055 //
00056 // <motivation>
00057 // There are places where LogicalArrays cannot be defined, i.e. where
00058 // LogiArray.h cannot be included.  In those places, one must provide
00059 // forward declarations for those objects which one is using.
00060 // This is particularly tricky for LogicalArrays, since they are not
00061 // classes, but are rather typedefs.  In order to make these forwards
00062 // easier to get correct, and easier to maintain, this file was created.
00063 // If LogicalArrays should ever be change to a class, only this file would
00064 // need to be changed, instead of every file where the current typedefs
00065 // would have to be changed to class forwards.
00066 // </motivation>
00067 //
00068 // <todo asof="$DATE:$>
00069 //   <li> Change LogicalArrayElem char.
00070 //   <li> Consider making these into classes.
00071 //   <li> Consider replacing with builtin boolean class when that
00072 //          makes it into the C++ compiler.
00073 // </todo>
00074 //
00075 // <linkfrom anchor="LogicalArray forwards" classes="Array MaskedArray">
00076 //    <here>LogicalArray forwards</here> --  Forward declarations for LogicalArrays.
00077 // </linkfrom>
00078 //
00079 // <group name="LogicalArray forwards">
00080 
00081 
00082 //# Typedefs
00083 
00084 // The element type for LogicalArray.
00085 // This should stay a typedef and not a class, so that it will work inside
00086 // of logical expressions without defining a cast to int, which would
00087 // lose its typesafeness.
00088 //
00089 typedef Bool LogicalArrayElem;
00090 
00091 
00092 //# Forwards
00093 
00094 template<class T> class Array;
00095 
00096 
00097 // Define LogicalArray.
00098 //
00099 typedef Array<LogicalArrayElem> LogicalArray;
00100 
00101 
00102 // </group>
00103 
00104 
00105 } //# NAMESPACE CASACORE - END
00106 
00107 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1