// -*- C++ -*-

// (c) COPYRIGHT URI/MIT 1999
// Please read the full copyright statement in the file COPYRIGHT.
//
// Authors:
//      jhrg,jimg       James Gallagher (jgallagher@gso.uri.edu)

// Interface for the InternalErr class
//
// 5/3/99 jhrg

// $Log: InternalErr.h,v $
// Revision 1.1  1999/05/04 19:43:47  jimg
// Added
//

#ifndef _internal_error_h
#define _internal_error_h 1

#ifdef __GNUG__
#pragma interface
#endif

#include <stdio.h>		// For FILE *

#include <string>

#include "Gui.h"
#include "Error.h"

/** The InternalErr class is used to signal that somewhere inside DODS a
    software fault was found. This class wraps the message text in some
    boiler plate that asks the error be reported to us (DODS support).

    NB: This class Adds some text to the message and might, in the future,
    hold information not also held in Error. However, all Error objects
    thrown on the server-side of DODS that cannot be resolved (and that's all
    of them for now, 5/3/99 jhrg) will be sent to the client-side \emph{using
    Error ojbects}. That is, the information recorded in an InternalErr
    object will be sent by calling the #print(...)# mfunc of Error.

    @memo A class for software fault reporting.
    @author jhrg */

class InternalErr: public Error {

public:
    /** These constructors always set the error code to #internal_error#.

	@memo Constructors for the Error object
	@name Constructors */
    //@{
    /// 
    InternalErr(string msg);
    ///
    InternalErr(string msg, ProgramType pt, char *pgm);
    ///
    InternalErr();
    ///
    InternalErr(const InternalErr &copy_from);
    //@}

    virtual ~InternalErr();

    /** 
	@memo Is the InternalErr object valid?
	@return TRUE if the object is valid, FALSE otherwise. */
    bool OK();
};

#endif // _internal_error_h