QgarErrorAlgorithm.H

Go to the documentation of this file.

/*---------------------------------------------------------------------+
 | Library QgarLib, graphics analysis and recognition                  |
 | Copyright (C) 2002  Qgar Project, LORIA                             |
 |                                                                     |
 | This library is free software; you can redistribute it and/or       |
 | modify it under the terms of the GNU Lesser General Public          |
 | License version 2.1, as published by the Free Software Foundation.  |
 |                                                                     |
 | 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 Lesser General Public License for more details.         |
 |                                                                     |
 | The GNU Lesser General Public License is included in the file       |
 | LICENSE.LGPL, in the root directory of the Qgar packaging. See      |
 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. |
 | To receive a paper copy, write to the Free Software Foundation,     |
 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.       |
 |                                                                     |
 | Contact Project Qgar for any information:                           |
 |   LORIA - équipe Qgar                                               |
 |   B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France                |
 |   email: qgar-contact@loria.fr                                      |
 |   http://www.qgar.org/                                              |
 *---------------------------------------------------------------------*/


#ifndef __QGARERRORALGORITHM_H_INCLUDED__
#define __QGARERRORALGORITHM_H_INCLUDED__


/**
 * @file    QgarErrorAlgorithm.H
 * @brief   Header file of class qgar::QgarErrorAlgorithm.
 *
 * @author  <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Gerald Masini">Gerald Masini</a>
 * @date    November 12, 2003  16:02
 * @since   Qgar 2.1
 */


// For RCS/CVS use: Do not delete
/* $Id: QgarErrorAlgorithm.H,v 1.9 2005/01/11 13:14:10 masini Exp $ */



// STL
#include <stdexcept>
#include <string>
// QGAR
#include <qgarlib/AbstractQgarError.H>



namespace qgar
{


/**
 * @class QgarErrorAlgorithm QgarErrorAlgorithm.H "qgarlib/QgarErrorAlgorithm.H"
 * @ingroup ERROR
 * @brief Class for Qgar algorithm exceptions.
 *
 * An algorithm exception is raised when an algorithm fails for a reason
 * that is in no way due to a bad implementation and that cannot be normally
 * anticipated by the user: For example, initial conditions that cannot
 * be set from the data set.
 * 
 * @author  <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Gerald Masini">Gerald Masini</a>
 * @date    November 12, 2003  16:02
 * @since   Qgar 2.1
 */
class QgarErrorAlgorithm

  : public std::runtime_error,
    public AbstractQgarError

{
// -------------------------------------------------------------------
// P U B L I C   M E M B E R S
// -------------------------------------------------------------------
public:

  /** @name Constructors */
  //        ============
  //@{
  /**
   * @brief Construct from the profile of the function throwing
   *        the exception, without displaying any error message.
   * @param aFuncProfile  profile of the function throwing the exception
   */
  QgarErrorAlgorithm(const char* aFuncProfile);

  /**
   * @brief Construct and display an error message.
   * @param aFileName     name of the file including the function throwing the exception
   * @param aLineNumber   line number (in the file) of the <b>throw</b> instruction
   * @param aFuncProfile  profile of the function throwing the exception
   * @param aDiagnostic   full explicit diagnostic
   *
   * An error message includes 4 lines:
   * - message header,  displayed by
   *   qgar::AbstractQgarError::displayErrorMessageHeader(const char*)
   * - file name and line number of the corresponding <b>throw</b> instruction
   * - function profile
   * - diagnostic
   */
  QgarErrorAlgorithm(const char* aFileName,
                     int aLineNumber,
                     const char* aFuncProfile,
                     const std::string aDiagnostic);
  //@}


  /** @name Destructor */
  //        ==========
  //@{
  /**
   * @brief Virtual destructor.
   */
  virtual ~QgarErrorAlgorithm() throw();
  //@}
  
// -------------------------------------------------------------------
}; // class QgarErrorAlgorithm


} // namespace qgar

#endif /* __QGARERRORALGORITHM_H_INCLUDED__ */