idl/SALOME_Exception.idl

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