casacore
casa
Arrays
LogiArrayFwd.h
Go to the documentation of this file.
1
//# LogiArrayFwd.h: Forwards for LogicalArrays.
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_LOGIARRAYFWD_H
29
#define CASA_LOGIARRAYFWD_H
30
31
32
#include <casacore/casa/aips.h>
33
34
namespace
casacore
{
//# NAMESPACE CASACORE - BEGIN
35
36
// <summary>
37
// Forward declarations for LogicalArrays.
38
// </summary>
39
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
40
//
41
// <prerequisite>
42
// <li> <linkto class=Array>Array</linkto>
43
// <li> <linkto group="LogiArray.h#LogicalArray">LogicalArray</linkto>
44
// </prerequisite>
45
//
46
// <etymology>
47
// LogiArrayFwd is short for LogicalArrayForwards, which was too long by
48
// the old AIPS++ file naming conventions.
49
// It contains forwards for LogicalArrays.
50
// </etymology>
51
//
52
// <synopsis>
53
// This file contains forward definitions for LogicalArrays.
54
// </synopsis>
55
//
56
// <motivation>
57
// There are places where LogicalArrays cannot be defined, i.e. where
58
// LogiArray.h cannot be included. In those places, one must provide
59
// forward declarations for those objects which one is using.
60
// This is particularly tricky for LogicalArrays, since they are not
61
// classes, but are rather typedefs. In order to make these forwards
62
// easier to get correct, and easier to maintain, this file was created.
63
// If LogicalArrays should ever be change to a class, only this file would
64
// need to be changed, instead of every file where the current typedefs
65
// would have to be changed to class forwards.
66
// </motivation>
67
//
68
// <todo asof="$DATE:$>
69
// <li> Change LogicalArrayElem char.
70
// <li> Consider making these into classes.
71
// <li> Consider replacing with builtin boolean class when that
72
// makes it into the C++ compiler.
73
// </todo>
74
//
75
// <linkfrom anchor="LogicalArray forwards" classes="Array MaskedArray">
76
// <here>LogicalArray forwards</here> -- Forward declarations for LogicalArrays.
77
// </linkfrom>
78
//
79
// <group name="LogicalArray forwards">
80
81
82
//# Typedefs
83
84
// The element type for LogicalArray.
85
// This should stay a typedef and not a class, so that it will work inside
86
// of logical expressions without defining a cast to int, which would
87
// lose its typesafeness.
88
//
89
typedef
Bool
LogicalArrayElem
;
90
91
92
//# Forwards
93
94
template
<
class
T>
class
Array
;
95
96
97
// Define LogicalArray.
98
//
99
typedef
Array<LogicalArrayElem>
LogicalArray
;
100
101
102
// </group>
103
104
105
}
//# NAMESPACE CASACORE - END
106
107
#endif
casacore::LogiArrayFwd_global_functions_LogicalArray_forwards::Array
Definition:
LogiArrayFwd.h:94
casacore::LogiArrayFwd_global_functions_LogicalArray_forwards::LogicalArray
Array< LogicalArrayElem > LogicalArray
Define LogicalArray.
Definition:
LogiArrayFwd.h:94
casacore
this file contains all the compiler specific defines
Definition:
mainpage.dox:28
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition:
aipstype.h:42
casacore::LogiArrayFwd_global_functions_LogicalArray_forwards::LogicalArrayElem
Bool LogicalArrayElem
The element type for LogicalArray.
Definition:
LogiArrayFwd.h:89
casacore::LogiArrayFwd_global_functions_LogicalArray_forwards
Forward declarations for LogicalArrays.
Definition:
LogiArrayFwd.h:80
Generated by
1.8.17