casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MaskArrIO.h
Go to the documentation of this file.
1 //# MaskArrIO.h: Write out an ascii representation of a MaskedArray.
2 //# Copyright (C) 1993,1994,1995,1999,2000,2001
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_MASKARRIO_H
29 #define CASA_MASKARRIO_H
30 
31 #include <casacore/casa/aips.h>
32 
33 //# Forward declarations
34 #include <casacore/casa/iosfwd.h>
35 namespace casacore { //# NAMESPACE CASACORE - BEGIN
36 
37 template<class T> class MaskedArray;
38 template<class T> class MaskedArray;
39 
40 
41 // <summary>
42 // Ascii input/output operations for MaskedArrays.
43 // </summary>
44 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMaskArrIO">
45 //
46 // <prerequisite>
47 // <li> <linkto class=Array>Array</linkto>
48 // <li> <linkto class=MaskedArray>MaskedArray</linkto>
49 // <li> <linkto group="ArrayIO.h#Array IO">ArrayIO</linkto>
50 // </prerequisite>
51 //
52 // <etymology>
53 // MaskArrIO is short for MaskedArrayIO, which is too long by the old
54 // AIPS++ file naming conventions. This file contains global functions
55 // for writing out ascii representations of masked arrays.
56 // </etymology>
57 //
58 // <synopsis>
59 // These functions write out masked arrays in ascii representation.
60 // They simply write out the Array and the LogicalArray which is the mask
61 // using the ascii output functions for these objects.
62 // </synopsis>
63 //
64 // <example>
65 // <srcblock>
66 // Vector<Int> a(10);
67 // LogicalVector b(10);
68 // MaskedArray m (a,b);
69 // . . .
70 // cout << m;
71 // </srcblock>
72 // This example writes out m in ascii. It writes first a and then
73 // the mask constructed from b.
74 // </example>
75 //
76 // <motivation>
77 // These are primarily for debugging, so that one can examine the MaskedArray.
78 // Since MaskedArrays are manipulators of Arrays, it was not thought to
79 // be necessary, or even a good idea, to have other kinds of IO defined
80 // for them.
81 // </motivation>
82 //
83 // <linkfrom anchor="MaskedArray IO" classes="MaskedArray">
84 // <here>MaskedArray IO</here> -- Ascii input/output operations
85 // for MaskedArrays.
86 // </linkfrom>
87 //
88 // <group name="MaskedArray IO">
89 
90 
91 //
92 // Write out an ascii representation of a MaskedArray.
93 // The component Array and LogicalArray are written out sequentially.
94 template<class T> ostream & operator<< (ostream &, const MaskedArray<T> &);
95 
96 
97 // </group>
98 
99 
100 } //# NAMESPACE CASACORE - END
101 
102 #ifndef CASACORE_NO_AUTO_TEMPLATES
103 #include <casacore/casa/Arrays/MaskArrIO.tcc>
104 #endif //# CASACORE_NO_AUTO_TEMPLATES
105 #endif
#define casacore
&lt;X11/Intrinsic.h&gt; #defines true, false, casacore::Bool, and String.
Definition: X11Intrinsic.h:42