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. The idl SALOME_Exception provides a generic CORBA exception for SALOME,
  28  with an attribute that gives an exception type,a message, plus optional source file name and line number.
  29 This idl is intended to serve for all user CORBA exceptions raised in SALOME code, as IDL specification
  30 does not support exception inheritance. So, all the user CORBA exceptions from SALOME could be
  31 handled in a single catch.
  32
  33 */
  34 #ifndef _SALOME_EXCEPTION_IDL_
  35 #define _SALOME_EXCEPTION_IDL_
  36
  37 /*!
  38 Module %SALOME regroups all idl definitions for %SALOME Kernel component
  39 */
  40
  41 module SALOME
  42 {
  43 /*!
  44 This enumeration contains the elements indicating the type of the exception
  45 which can be raised during %SALOME session.
  46 */
  47   enum ExceptionType
  48     {
  49       COMM,             /*!< Communication problem */
  50       BAD_PARAM,        /*!< Bad User parameters */
  51       INTERNAL_ERROR    /*!< Application level problem, irrecoverable */
  52     };
  53 /*!
  54 This struct contains a set of fields defining the structure of the exception.
  55 */
  56   struct ExceptionStruct
  57   {
  58     ExceptionType type; /*!<Type of the exception.*/
  59     string        text; /*!<Message which is shown when the exception is raised.*/
  60     string        sourceFile; /*!<The source file where the exception is raised.*/
  61     unsigned long lineNumber; /*!<Number of the line of the source file where the exception is raised.*/
  62   };
  63 /*!
  64 The main exception in %SALOME application.
  65 */
  66   exception SALOME_Exception
  67   {
  68     ExceptionStruct details;
  69   };
  70
  71 };
  72
  73 #endif