Exceptions.h

Go to the documentation of this file.

//# Exceptions.h:  a module for exception handling
//# Copyright (C) 1995,1999,2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id$

#ifndef CASA_EXCEPTIONS_H
#define CASA_EXCEPTIONS_H


#include <casacore/casa/aips.h>

#include <casacore/casa/Exceptions/Error.h>

namespace casacore { //# NAMESPACE CASACORE - BEGIN

// <module>
//
// <summary>
//     Exception handling
// </summary>
//
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" demos="">
// </reviewed>
//
// <synopsis>
// This module provides the exception handling mechanism used in Casacore.
// It allows the user to define new exception types and to <src>throw</src>,
// <src>catch</src>, and <src>rethrow</src> these exceptions. The interface
// to this exception handling mechanism is very similary to the ANSI standard
// exceptions. This will make it easy to switch when the time comes.
//
// This module supplies several <linkto file="Error.h">common exception types </linkto>.
// These provide examples for creating new errors.
//
// At some point, this exception mechanism will probably be replaced with
// compiler supported exceptions.
// </synopsis>
//
// <example>
// <em>This example shows how a more specific exception can be caught as
// a more general exception:</em>
// <srcblock>
//     #include <casacore/casa/Exceptions.h>
//     #include <iostream>
//     main() {
//         try {
//             throw(indexError<int>(5,"Dummy error"));
//         } catch (IndexError xx) {
//             cout << "caught IndexError" << endl;
//         } 
//     }
// </srcblock>
// </example>
// </module>


} //# NAMESPACE CASACORE - END

#endif