# -*- coding: iso-8859-1 -*-
-# Copyright (C) 2010-2013 CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2010-2016 CEA/DEN, EDF R&D, OPEN CASCADE
#
# 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.
+# 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
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+
+## \defgroup uiexception uiexception
+# \{
+# \details Exception for user error management
+# \}
+
__author__="gboulant"
__date__ ="$31 mars 2010 11:59:33$"
from enumerate import Enumerate
+## This exception should be used for functionnal error management, at least in the GUI
+# part of the application, for example to set user oriented messages at point
+# of exception raise.
+# \warning The exception should NOT be used to hide defaults in the algorithm, but
+# only predicted error in the specified use case.
+# \ingroup uiexception
class UiException(Exception):
TYPES = Enumerate([
WARN: The exception should NOT be used to hide defaults in the algorithm, but
only predicted error in the specified use case.
"""
+
+ ## Canonical constructor
def __init__(self, message, type=TYPES.USER):
"""Canonical constructor"""
Exception.__init__(self,message)
def getUIMessage(self):
return self._UImessage
+ ## Specify the type of this exception. To be chosen in the TYPES list.
def setType(self, type):
- """Specify the type of this exception. To be choosen in the TYPES list."""
+ """Specify the type of this exception. To be chosen in the TYPES list."""
if not self.TYPES.isValid(type):
raise UiException("The exception type "+str(type)+" can't be used",self.TYPES.DEVEL)
self._type = type