casacore
Utilities.h
Go to the documentation of this file.
1 //# Utilities.h: Bag of unrelated classes and groups for general use.
2 //# Copyright (C) 1995,1996,1997,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 
29 #ifndef CASA_UTILITIES_H
30 #define CASA_UTILITIES_H
31 
32 #include <casacore/casa/aips.h>
33 
34 #include <casacore/casa/Utilities/Assert.h>
35 #include <casacore/casa/Utilities/BinarySearch.h>
36 #include <casacore/casa/Utilities/BitVector.h>
37 #include <casacore/casa/Utilities/Compare.h>
38 #include <casacore/casa/Utilities/Copy.h>
39 #include <casacore/casa/Utilities/CountedPtr.h>
40 #include <casacore/casa/Utilities/DataType.h>
41 #include <casacore/casa/Utilities/DynBuffer.h>
42 #include <casacore/casa/Utilities/Fallible.h>
43 #include <casacore/casa/Utilities/GenSort.h>
44 #include <casacore/casa/Utilities/Notice.h>
45 #include <casacore/casa/Utilities/PtrHolder.h>
46 #include <casacore/casa/Utilities/RegSequence.h>
47 #include <casacore/casa/Utilities/Regex.h>
48 #include <casacore/casa/Utilities/Register.h>
49 #include <casacore/casa/Utilities/Sequence.h>
50 #include <casacore/casa/Utilities/Sort.h>
51 #include <casacore/casa/Utilities/SortError.h>
52 #include <casacore/casa/BasicSL/String.h>
53 #include <casacore/casa/Utilities/ValType.h>
54 
55 namespace casacore { //# NAMESPACE CASACORE - BEGIN
56 
57 // <module>
58 //
59 // <summary> Classes and global functions for general use </summary>
60 
61 // <reviewed reviewer="Friso Olnon" date="1995/03/20" demos="">
62 // </reviewed>
63 
64 // <synopsis>
65 //
66 // This module is a bag of unrelated mini-modules, classes and
67 // global functions. The following functional groups can be recognized:
68 // <ul>
69 // <li> Object utilities:
70 // <ul>
71 // <li> <linkto class=ObjCompare>ObjCompare</linkto>
72 // objects with each other. A signature for comparison functions
73 // is defined (required for comparison functions used in the
74 // <linkto class=Sort>Sort</linkto>
75 // class), and one such function is provided.
76 // <li> <linkto group="Copy.h#copy">objcopy/objmove/objset</linkto>
77 // copies objects from one place to another.
78 // <li> <linkto class=Fallible>Mark</linkto>
79 // objects as valid or invalid.
80 // <li> <linkto class=Notice>Notices</linkto>
81 // provide basic support for shared access of data by various objects.
82 // <li> <linkto class=Sort>Sort</linkto>
83 // objects on one or more keys, in ascending or descending order.
84 // <linkto class=GenSort>Fast sorting</linkto>
85 // is provided for certain types of objects.
86 // <li> <linkto group="BinarySearch.h#binarysearch">Binary Search</linkto>
87 // templated functions for sorted containers (ascending or descending
88 // order) are available.
89 // <li> <linkto group="LinearSearch.h#linearsearch">Linear Search</linkto>
90 // templated functions for unsorted containers are available.
91 // </ul>
92 // <li> Logical utilities:
93 // <ul>
94 // <li> <linkto class=assert_>Assertion</linkto>
95 // lets you throw an error when a condition in not fullfilled.
96 // <li> <linkto class=BitVector>Bit vectors</linkto>
97 // are an efficient method to keep True/False information on a set of
98 // items or conditions.
99 // </ul>
100 // <li> Pointer utilities
101 // <ul>
102 // <li> <linkto class=CountedPtr>Counted pointers</linkto>
103 // provide support for reference counting.
104 // <li> <linkto class=PtrHolder>Pointer holders</linkto>
105 // can be used to hold allocated pointers which should be deleted
106 // when an exception is thrown.
107 // </ul>
108 // <li> Datatype utilities
109 // <ul>
110 // <li> <linkto group="DataType.h#DataType">DataType</linkto>
111 // enumerates the possible data types in the table system.
112 // <li> <linkto class=ValType>ValType</linkto>
113 // describes the data types and their undefined values.
114 // <li> <linkto group="Register.h#register">Register</linkto>
115 // provides runtime typing information.
116 // </ul>
117 // <li> Other utilities
118 // <ul>
119 // <li> <linkto class=DynBuffer>Dynamic buffers</linkto>
120 // are used to store data in dynamically allocated buffers.
121 // <li> <linkto class=Regex>Regular expressions</linkto>
122 // are supported by the class <linkto class=Regex>Regex</linkto>
123 // built on top of std::regex.
124 // <li> <linkto class=Sequence>Sequences</linkto>
125 // of any datatype can be derived from the base class
126 // <linkto class=Sequence>Sequence</linkto>.
127 // One example is <linkto class=uIntSequence>uIntSequence</linkto>,
128 // provided for general use. Another is
129 // <linkto class=RegSequence>RegSequence</linkto>, exclusively used
130 // by the <linkto group="Register.h#register">Register</linkto> function.
131 // <li> <linkto class=String>Strings</linkto>.
132 // for the C++ preprocessor
133 // </ul>
134 // </ul>
135 //
136 // <note role=tip> You may want to look at the individual header files
137 // to see whether you might not prefer to include only the header
138 // files you really need; it may be more efficient to do so.
139 // </note>
140 //
141 // </synopsis>
142 
143 //# <todo asof="1995/03/20">
144 //# <li>
145 //# </todo>
146 
147 // </module>
148 
149 
150 } //# NAMESPACE CASACORE - END
151 
152 #endif
153 
this file contains all the compiler specific defines
Definition: mainpage.dox:28