Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

MayDay.H

Go to the documentation of this file.
00001 /* _______              __
00002   / ___/ /  ___  __ _  / /  ___
00003  / /__/ _ \/ _ \/  ' \/ _ \/ _ \
00004  \___/_//_/\___/_/_/_/_.__/\___/ 
00005 */
00006 //
00007 // This software is copyright (C) by the Lawrence Berkeley
00008 // National Laboratory.  Permission is granted to reproduce
00009 // this software for non-commercial purposes provided that
00010 // this notice is left intact.
00011 // 
00012 // It is acknowledged that the U.S. Government has rights to
00013 // this software under Contract DE-AC03-765F00098 between
00014 // the U.S.  Department of Energy and the University of
00015 // California.
00016 //
00017 // This software is provided as a professional and academic
00018 // contribution for joint exchange. Thus it is experimental,
00019 // is provided ``as is'', with no warranties of any kind
00020 // whatsoever, no support, no promise of updates, or printed
00021 // documentation. By using this software, you acknowledge
00022 // that the Lawrence Berkeley National Laboratory and
00023 // Regents of the University of California shall have no
00024 // liability with respect to the infringement of other
00025 // copyrights by any part of this software.
00026 //
00027 
00028 #ifndef CH_MayDay_H
00029 #define CH_MayDay_H
00030 
00031 //
00032 // $Id: MayDay.H,v 1.2 2001/06/20 02:56:56 ligocki Exp $
00033 //
00034 
00035 //
00036 //@Man:
00037 //@Memo: Error-reporting Functions and Version Number
00038 /*@Doc:
00039 
00040   This class consists entirely of static error-reporting functions that
00041   are used throughout the MayDay implementation together with a version
00042   string.  In the best of all possible worlds we'd use a namespace, but
00043   we aren't there, yet :-)  Note that all the output functions add a
00044   terminating exclamation mark, so there is no need to add any punction
00045   to sentences that get output explicitly.
00046 */
00047 
00048 class MayDay
00049 {
00050 protected:
00051   //
00052   // A null string used as a default argument by the following functions.
00053   //
00054   static const char* nullString;
00055 public:
00057 
00060   static void Error (const char * msg = nullString);
00061 
00063 
00066   static void Abort (const char * msg = nullString);
00067 
00069 
00072   static void Warning(const char* msg = nullString);
00073 
00074   /* The MayDay version string.
00075     
00076     Has the form:
00077     
00078     MayDay version 2.0 built Jun 25 1996 at 14:52:36
00079     */
00080   static const char * const version;
00081 
00082 };
00083 
00084 
00085 #endif /*CH_MayDay_H*/

Generated on Thu Aug 29 11:05:45 2002 for Chombo&INS by doxygen1.2.16