-//=============================================================================
-// File : SALOME_Exception.idl
-// Created : mar déc 18 17:57:27 CET 2001
-// Author : Paul RASCLE, EDF
-// Project : SALOME
-// Copyright : EDF 2001
-// $Header$
-//=============================================================================
-
-/*! \file SALOME_Exception.idl This file contains the objects defining the main exception used
-in %SALOME application.
+// Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// 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.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+// File : SALOME_Exception.idl
+// Author : Paul RASCLE, EDF
+// $Header$
+//
+/*! \file SALOME_Exception.idl \brief This file contains the objects defining the main exception used
+in %SALOME application.
+
+The idl SALOME_Exception provides a generic CORBA exception for SALOME,
+ with an attribute that gives an exception type,a message, plus optional source file name and line number.
+This idl is intended to serve for all user CORBA exceptions raised in SALOME code, as IDL specification
+does not support exception inheritance. So, all the user CORBA exceptions from SALOME could be
+handled in a single catch.
+
*/
#ifndef _SALOME_EXCEPTION_IDL_
#define _SALOME_EXCEPTION_IDL_
-/*!
-Module SALOME regroups all idl definitions for SALOME Kernel
+/*! \brief
+Module %SALOME contains all base interfaces of %SALOME Kernel
+
*/
module SALOME
{
-/*!
-This enumeration contains the elements indicating the type of the exception.
-*/
+//! This enumeration contains the elements indicating the type of the exception which can be raised during %SALOME session.
enum ExceptionType
{
COMM, /*!< Communication problem */
BAD_PARAM, /*!< Bad User parameters */
- INTERNAL_ERROR /*!< SALOME Bug, irrecoverable */
+ INTERNAL_ERROR /*!< Application level problem, irrecoverable */
};
-/*!
-This struct contains a set of fields defining the structure of the exception.
-*/
+//! This struct contains a set of fields defining the structure of the exception.
struct ExceptionStruct
{
ExceptionType type; /*!<Type of the exception.*/
string sourceFile; /*!<The source file where the exception is raised.*/
unsigned long lineNumber; /*!<Number of the line of the source file where the exception is raised.*/
};
-/*!
-The main exception in %SALOME application.
+/*! \brief The main exception in %SALOME application.
+
+The idl SALOME_Exception provides a generic CORBA exception for SALOME,
+ with an attribute that gives an exception type,a message, plus optional source file name and line number.
+ This idl is intended to serve for all user CORBA exceptions raised in SALOME code, as IDL specification
+ does not support exception inheritance. So, all the user CORBA exceptions from SALOME could be
+ handled in a single catch.
*/
exception SALOME_Exception
{
- ExceptionStruct details;
+ ExceptionStruct details; /*!<Structure of the exception.*/
};
};
