---

exception.hh

/*
*  Name:      exception.hh
*  Author:    Rafael Jesus Alcantara Perez
*  Summary:   Exception class
*  Date:      $Date: 2003/10/06 12:45:11 $
*  Revision:  $Revision: 1.1 $
*
*  Copyright (C) 1994-2003  Rafael Jesus Alcantara Perez <rafa@dedalo-ing.com>
*
*  This program is free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  This program 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 General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program; if not, write to the Free Software
*  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
*  MA 02111-1307, USA.
*/

#ifndef _MPCL_EXCEPTION__
#define _MPCL_EXCEPTION__

#include <string>
#include "io/output_streamable.hh"


namespace mpcl
{

  using io::IOutputStreamable;
  using std::basic_ostream;
  using std::string;

  class TException: public IOutputStreamable<>
  {

    protected:

      string   ySynopsis;

      string   yRationale;

      string   yFileName;

      int   iLineNumber;


    public:

      //
      //  C O N S T R U C T O R S
      //
 
      TException (void)         :
        IOutputStreamable<> ()  ,
        ySynopsis           ()  ,
        yRationale          ()  ,
        yFileName           ()  ,
        iLineNumber         (0) {}

      TException ( const string& rkySYNOPSYS              ,
                   const string& rkyRATIONALE  = string() ,
                   const string& rkyFILE_NAME  = string() ,
                   const int     kiLINE_NUMBER = 0        ) :
        IOutputStreamable<> ()                              ,
        ySynopsis           (rkySYNOPSYS)                   ,
        yRationale          (rkyRATIONALE)                  ,
        yFileName           (rkyFILE_NAME)                  ,
        iLineNumber         (kiLINE_NUMBER)                 {}

      TException (const TException& rktSOURCE_EXCEPTION) :
        IOutputStreamable<> ()                                ,
        ySynopsis           (rktSOURCE_EXCEPTION.ySynopsis)   ,
        yRationale          (rktSOURCE_EXCEPTION.yRationale)  ,
        yFileName           (rktSOURCE_EXCEPTION.yFileName)   ,
        iLineNumber         (rktSOURCE_EXCEPTION.iLineNumber) {}


    public:

      //
      //  S E L E C T O R S
      //

      const string& generalDescription (void) const throw()
      {
        return ySynopsis;
      }

      const string& specificDescription (void) const throw()
      {
        return yRationale;
      }

      const string& fileName (void) const throw()
      {
        return yFileName;
      }

      int lineNumber (void) const throw()
      {
        return iLineNumber;
      }

      virtual const string what (void) const;


    protected:

      //
      //  S E L E C T O R S
      //
      
      void write (basic_ostream<char_type, traits_type>& rtOUTPUT_OSTREAM) const
      {
        rtOUTPUT_OSTREAM << what() << std::endl;
      }

  };  // class TException

}  // namespace mpcl


#endif  // not _MPCL_EXCEPTION__

---