casacore
Containers.h
Go to the documentation of this file.
1 //# <Containers.h>: a module for non-mathematical containers
2 //# Copyright (C) 1995,1999,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_CONTAINERS_H
29 #define CASA_CONTAINERS_H
30 
31 #include <casacore/casa/aips.h>
32 
33 #include <casacore/casa/Containers/Block.h>
34 #include <casacore/casa/Containers/Link.h>
35 #include <casacore/casa/Containers/List.h>
36 #include <casacore/casa/Containers/ListMap.h>
37 #include <casacore/casa/Containers/Map.h>
38 #include <casacore/casa/Containers/OrderedPair.h>
39 #include <casacore/casa/Containers/Record.h>
40 #include <casacore/casa/Containers/RecordField.h>
41 #include <casacore/casa/Containers/SimOrdMap.h>
42 #include <casacore/casa/Containers/OrderedMap.h>
43 #include <casacore/casa/Containers/Queue.h>
44 #include <casacore/casa/Containers/Stack.h>
45 
46 #include <casacore/casa/Containers/BlockIO.h>
47 #include <casacore/casa/Containers/ListIO.h>
48 #include <casacore/casa/Containers/ListMapIO.h>
49 #include <casacore/casa/Containers/OrdPairIO.h>
50 #include <casacore/casa/Containers/OrdMapIO.h>
51 #include <casacore/casa/Containers/SimOrdMapIO.h>
52 #include <casacore/casa/Containers/MapIO.h>
53 
54 #include <casacore/casa/Containers/StackError.h>
55 #include <casacore/casa/Containers/IterError.h>
56 
57 namespace casacore { //# NAMESPACE CASACORE - BEGIN
58 
59 // <module>
60 //
61 // <summary>
62 // Non-mathematical Containers
63 // </summary>
64 //
65 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" demos="">
66 // </reviewed>
67 //
68 // <synopsis>
69 // This module provides non-mathematical containers. These containers are the
70 // prototypical computer science types of containers -- <linkto
71 // class=Queue>queues</linkto>, <linkto class=Stack>stacks</linkto>, <linkto
72 // class=List>lists</linkto>, <linkto class=Map>associative arrays</linkto>,
73 // <linkto class="Record">records</linkto> and <linkto class=Block>simple
74 // arrays</linkto>. These classes are useful for all of the various types of low
75 // level data management. In general, these classes will have familiar semantics
76 // and an unsurprising interface.
77 //
78 // Most of the important classes in this module also have IO shift operators,
79 // e.g. for <linkto file=BlockIO.h#BlockIO>writing out a Block</linkto> (simple
80 // array). These operators typically allow the container (and the objects it
81 // contains) to be written out to both <linkto class=AipsIO>AipsIO</linkto> and
82 // the standard <em>ostream</em>.
83 //
84 // The class Block has the option to trace (de)allocations for Blocks with
85 // a size above a given threshold. It uses class MemoryTrace to log the
86 // trace messages. Unlike MemoryTrace, it also works on non-Linux systems.
87 // Since class Array uses Block underneath, it makes it possible to trace
88 // Array usage.
89 // </synopsis>
90 //
91 // </module>
92 
93 
94 } //# NAMESPACE CASACORE - END
95 
96 #endif
this file contains all the compiler specific defines
Definition: mainpage.dox:28