casacore: casa/Containers.h Source File

Go to the documentation of this file.
00001 //# <Containers.h>:  a module for non-mathematical containers
00002 //# Copyright (C) 1995,1999,2001
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: Containers.h 20551 2009-03-25 00:11:33Z Malte.Marquarding $
00027 
00028 #ifndef CASA_CONTAINERS_H
00029 #define CASA_CONTAINERS_H
00030 
00031 #include <casa/Containers/Block.h>
00032 #include <casa/Containers/Link.h>
00033 #include <casa/Containers/List.h>
00034 #include <casa/Containers/ListMap.h>
00035 #include <casa/Containers/Map.h>
00036 #include <casa/Containers/OrderedPair.h>
00037 #include <casa/Containers/Record.h>
00038 #include <casa/Containers/RecordField.h>
00039 #include <casa/Containers/SimOrdMap.h>
00040 #include <casa/Containers/OrderedMap.h>
00041 #include <casa/Containers/Queue.h>
00042 #include <casa/Containers/Stack.h>
00043 
00044 #include <casa/Containers/BlockIO.h>
00045 #include <casa/Containers/ListIO.h>
00046 #include <casa/Containers/ListMapIO.h>
00047 #include <casa/Containers/OrdPairIO.h>
00048 #include <casa/Containers/OrdMapIO.h>
00049 #include <casa/Containers/SimOrdMapIO.h>
00050 #include <casa/Containers/MapIO.h>
00051 
00052 #include <casa/Containers/StackError.h>
00053 #include <casa/Containers/IterError.h>
00054 
00055 namespace casa { //# NAMESPACE CASA - BEGIN
00056 
00057 // <module>
00058 //
00059 // <summary>
00060 //     Non-mathematical Containers
00061 // </summary>
00062 //
00063 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" demos="">
00064 // </reviewed>
00065 //
00066 // <synopsis>
00067 //    This module provides non-mathematical containers. These containers are the
00068 //    prototypical computer science types of containers -- <linkto
00069 //    class=Queue>queues</linkto>, <linkto class=Stack>stacks</linkto>, <linkto
00070 //    class=List>lists</linkto>, <linkto class=Map>associative arrays</linkto>,
00071 //    <linkto class="Record">records</linkto> and <linkto class=Block>simple
00072 //    arrays</linkto>. These classes are useful for all of the various types of low
00073 //    level data management. In general, these classes will have familiar semantics
00074 //    and an unsurprising interface.
00075 //
00076 //    Most of the important classes in this module also have IO shift operators,
00077 //    e.g. for <linkto file=BlockIO.h#BlockIO>writing out a Block</linkto> (simple
00078 //    array). These operators typically allow the container (and the objects it
00079 //    contains) to be written out to both <linkto class=AipsIO>AipsIO</linkto> and
00080 //    the standard <em>ostream</em>.
00081 // </synopsis>
00082 //
00083 // </module>
00084 
00085 
00086 } //# NAMESPACE CASA - END
00087 
00088 #endif