casacore
MaskLogiArrFwd.h
Go to the documentation of this file.
1//# MaskLogiArrFwd.h: Forwards for MaskedLogicalArrays.
2//# Copyright (C) 1994,1995,1999
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 addressed 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//# $Id$
27
28#ifndef CASA_MASKLOGIARRFWD_2_H
29#define CASA_MASKLOGIARRFWD_2_H
30
31//# There is no source file, so this pragma is not needed.
32#if 0
33#endif
34
35#include "ArrayFwd.h"
36
37namespace casacore { //# NAMESPACE CASACORE - BEGIN
38
39// <summary>
40// Forward declarations for MaskedLogicalArrays.
41// </summary>
42// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMaskedArray">
43//
44// <prerequisite>
45// <li> <linkto class=Array>Array</linkto>
46// <li> <linkto class=MaskedArray>MaskedArray</linkto>
47// <li> <linkto group="LogiArray.h#LogicalArray">LogicalArray</linkto>
48// </prerequisite>
49//
50// <etymology>
51// MaskLogiArrayFwd is short for MaskedLogicalArrayForwards, which is
52// too long by the old AIPS++ file naming conventions.
53// It contains forwards for MaskedLogicalArrays.
54// </etymology>
55//
56// <synopsis>
57// This file contains forward definitions for MaskedLogicalArrays.
58// </synopsis>
59//
60// <motivation>
61// There are places where MaskedLogicalArrays cannot be defined, i.e. where
62// MaskLogiArr.h cannot be included. In those places, one must provide
63// forward declarations for those objects which one is using.
64// This is particularly tricky for MaskedLogicalArrays, since they are not
65// classes, but are rather typedefs. In order to make these forwards
66// easier to get correct, and easier to maintain, this file was created.
67// If MaskedLogicalArrays should ever be change to a class, only this file would
68// need to be changed, instead of every file where the current typedefs
69// would have to be changed to class forwards.
70// </motivation>
71//
72// <todo asof="$DATE:$>
73// <li> Consider making these into classes.
74// <li> Consider replacing with builtin boolean class when that
75// makes it into the C++ compiler.
76// </todo>
77//
78// <linkfrom anchor="MaskedLogicalArray forwards" classes="Array MaskedArray">
79// <here>MaskedLogicalArray forwards</here> -- Forward declarations for
80// MaskedLogicalArrays.
81// </linkfrom>
82//
83// <group name="MaskedLogicalArray forwards">
85
86//# Forwards
87
88template<typename T, typename ArrayAlloc=std::allocator<T>, typename MaskAlloc=std::allocator<LogicalArrayElem>> class MaskedArray;
89
90
91// Define MaskedLogicalArray.
92//
94
95
96// </group>
97
98
99} //# NAMESPACE CASACORE - END
100
101#endif
this file contains all the compiler specific defines
Definition: mainpage.dox:28
MaskedArray< LogicalArrayElem > MaskedLogicalArray
Define MaskedLogicalArray.