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/Record.h>
35#include <casacore/casa/Containers/RecordField.h>
36
37#include <casacore/casa/Containers/BlockIO.h>
38
39#include <casacore/casa/Containers/IterError.h>
40
41namespace casacore { //# NAMESPACE CASACORE - BEGIN
42
43// <module>
44//
45// <summary>
46// Non-mathematical Containers
47// </summary>
48//
49// <reviewed reviewer="UNKNOWN" date="before2004/08/25" demos="">
50// </reviewed>
51//
52// <synopsis>
53// This module provides non-mathematical containers. These containers are the
54// prototypical computer science types of containers --
55// <linkto class="Record">records</linkto> and <linkto class=Block>simple
56// arrays</linkto>. These classes are useful for all of the various types of low
57// level data management. In general, these classes will have familiar semantics
58// and an unsurprising interface.
59// Note that Casacore used to have classes such as Map and List, but they
60// became obsolete when the Standard C++ Library was introduced. Therefore these
61// classes have been removed.
62//
63// Most of the important classes in this module also have IO shift operators,
64// e.g. for <linkto file=BlockIO.h#BlockIO>writing out a Block</linkto> (simple
65// array). These operators typically allow the container (and the objects it
66// contains) to be written out to both <linkto class=AipsIO>AipsIO</linkto> and
67// the standard <em>ostream</em>.
68//
69// The class Block has the option to trace (de)allocations for Blocks with
70// a size above a given threshold. It uses class MemoryTrace to log the
71// trace messages. Unlike MemoryTrace, it also works on non-Linux systems.
72// Since class Array uses Block underneath, it makes it possible to trace
73// Array usage.
74// </synopsis>
75//
76// </module>
77
78
79} //# NAMESPACE CASACORE - END
80
81#endif
this file contains all the compiler specific defines
Definition: mainpage.dox:28