idl/SALOME_Exception.idl

   1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  19 //
  20 //
  21 //
  22 //  File   : SALOME_Exception.idl
  23 //  Author : Paul RASCLE, EDF
  24 //  $Header$
  25
  26 /*! \file SALOME_Exception.idl This file contains the objects defining the main exception used
  27 in %SALOME application.
  28 */
  29 #ifndef _SALOME_EXCEPTION_IDL_
  30 #define _SALOME_EXCEPTION_IDL_
  31
  32 /*!
  33 Module SALOME regroups all idl definitions for SALOME Kernel
  34 */
  35
  36 module SALOME
  37 {
  38 /*!
  39 This enumeration contains the elements indicating the type of the exception.
  40 */
  41   enum ExceptionType
  42     {
  43       COMM,             /*!< Communication problem */
  44       BAD_PARAM,        /*!< Bad User parameters */
  45       INTERNAL_ERROR    /*!< SALOME Bug, irrecoverable */
  46     };
  47 /*!
  48 This struct contains a set of fields defining the structure of the exception.
  49 */
  50   struct ExceptionStruct
  51   {
  52     ExceptionType type; /*!<Type of the exception.*/
  53     string        text; /*!<Message which is shown when the exception is raised.*/
  54     string        sourceFile; /*!<The source file where the exception is raised.*/
  55     unsigned long lineNumber; /*!<Number of the line of the source file where the exception is raised.*/
  56   };
  57 /*!
  58 The main exception in %SALOME application.
  59 */
  60   exception SALOME_Exception
  61   {
  62     ExceptionStruct details;
  63   };
  64
  65 };
  66
  67 #endif