Back to index

salome-kernel  6.5.0
Public Member Functions | Static Public Attributes | Private Attributes | Static Private Attributes
KERNEL_PY.kernel.uiexception.UiException Class Reference
Collaboration diagram for KERNEL_PY.kernel.uiexception.UiException:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def setUIMessage
def getUIMessage
def setType
def getType
def __str__

Static Public Attributes

tuple TYPES

Private Attributes

 _UImessage

Static Private Attributes

string _UImessage = "An error occurs"
 _type = TYPES.USER

Detailed Description

Definition at line 25 of file uiexception.py.


Constructor & Destructor Documentation

def KERNEL_PY.kernel.uiexception.UiException.__init__ (   self,
  message,
  type = TYPES.USER 
)
Canonical constructor

Definition at line 43 of file uiexception.py.

00043 
00044     def __init__(self, message, type=TYPES.USER):
00045         """Canonical constructor"""
00046         Exception.__init__(self,message)
00047         self.setUIMessage(message)
00048         self.setType(type)

Here is the call graph for this function:


Member Function Documentation

Definition at line 64 of file uiexception.py.

00064 
00065     def __str__(self):
00066         return self.getUIMessage()
00067 

Here is the call graph for this function:

Definition at line 61 of file uiexception.py.

00061 
00062     def getType(self):
00063         return self._type

Definition at line 52 of file uiexception.py.

00052 
00053     def getUIMessage(self):
00054         return self._UImessage

Here is the caller graph for this function:

Specify the type of this exception. To be choosen in the TYPES list.

Definition at line 55 of file uiexception.py.

00055 
00056     def setType(self, type):
00057         """Specify the type of this exception. To be choosen in the TYPES list."""
00058         if not self.TYPES.isValid(type):
00059             raise UiException("The exception type "+str(type)+" can't be used",self.TYPES.DEVEL)
00060         self._type = type

Here is the caller graph for this function:

Definition at line 49 of file uiexception.py.

00049 
00050     def setUIMessage(self, UImessage):
00051         self._UImessage = UImessage

Here is the caller graph for this function:


Member Data Documentation

KERNEL_PY.kernel.uiexception.UiException._type = TYPES.USER [static, private]

Definition at line 34 of file uiexception.py.

string KERNEL_PY.kernel.uiexception.UiException._UImessage = "An error occurs" [static, private]

Definition at line 33 of file uiexception.py.

Definition at line 50 of file uiexception.py.

Initial value:
Enumerate([
        'USER',  # This type should be displayed to end user using a dialog box
        'ADMIN', # This type should be displayed to admin user in console log
        'DEVEL'  # This type should be displayed to developer only
    ])

Definition at line 27 of file uiexception.py.


The documentation for this class was generated from the following file: