uiexception.UiException Class Reference

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. More...

Inheritance diagram for uiexception.UiException:

Public Member Functions
def	__init__ (self, message, type=TYPES.USER)
	Canonical constructor. More...
def	setUIMessage (self, UImessage)
def	getUIMessage (self)
def	setType (self, type)
	Specify the type of this exception. More...
def	getType (self)
def	__str__ (self)

Static Public Attributes
	TYPES

Private Attributes
	_UImessage

Static Private Attributes
string	_UImessage = "An error occurs"
	_type = TYPES.USER

Detailed Description

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.

Constructor & Destructor Documentation

__init__()

def uiexception.UiException.__init__	(		self,
			message,
			type = TYPES.USER
	)

Canonical constructor.

References SALOMEDSImpl_GenericVariable.setType(), uiexception.UiException.setType(), KERNEL_PY.kernel.uiexception.UiException.setType(), KERNEL_PY.kernel.testdata.TestData.setType(), uiexception.UiException.setUIMessage(), and KERNEL_PY.kernel.uiexception.UiException.setUIMessage().

Member Function Documentation

__str__()

def uiexception.UiException.__str__

(

self

)

References uiexception.UiException.getUIMessage(), and KERNEL_PY.kernel.uiexception.UiException.getUIMessage().

getType()

def uiexception.UiException.getType

(

self

)

References uiexception.UiException._type, SALOME_Matrix_i._type, SALOMEMultiComm._type, DF_Document._type, HDFattribute._type, HDFdataset._type, KERNEL_PY.kernel.uiexception.UiException._type, SALOMEDS_AttLong_i._type, SALOMEDS_AttReal_i._type, SALOMEDSImpl_GenericAttribute._type, SALOMEDSImpl_GenericVariable._type, and SALOMEDSImpl_SObject._type.

getUIMessage()

def uiexception.UiException.getUIMessage

(

self

)

References uiexception.UiException._UImessage, and KERNEL_PY.kernel.uiexception.UiException._UImessage.

Referenced by uiexception.UiException.__str__(), and KERNEL_PY.kernel.uiexception.UiException.__str__().

setType()

def uiexception.UiException.setType	(		self,
			type
	)

Specify the type of this exception.

To be chosen in the TYPES list.

References uiexception.UiException._type, SALOME_Matrix_i._type, SALOMEMultiComm._type, DF_Document._type, HDFattribute._type, HDFdataset._type, KERNEL_PY.kernel.uiexception.UiException._type, SALOMEDS_AttLong_i._type, SALOMEDS_AttReal_i._type, SALOMEDSImpl_GenericAttribute._type, SALOMEDSImpl_GenericVariable._type, SALOMEDSImpl_SObject._type, uiexception.UiException.TYPES, and KERNEL_PY.kernel.uiexception.UiException.TYPES.

Referenced by uiexception.UiException.__init__(), and KERNEL_PY.kernel.uiexception.UiException.__init__().

setUIMessage()

def uiexception.UiException.setUIMessage	(		self,
			UImessage
	)

Referenced by uiexception.UiException.__init__(), and KERNEL_PY.kernel.uiexception.UiException.__init__().

Field Documentation

_type

uiexception.UiException._type = TYPES.USER

staticprivate

Referenced by uiexception.UiException.getType(), KERNEL_PY.kernel.uiexception.UiException.getType(), uiexception.UiException.setType(), and KERNEL_PY.kernel.uiexception.UiException.setType().

_UImessage [1/2]

string uiexception.UiException._UImessage = "An error occurs"

staticprivate

Referenced by uiexception.UiException.getUIMessage(), and KERNEL_PY.kernel.uiexception.UiException.getUIMessage().

_UImessage [2/2]

uiexception.UiException._UImessage

private

Referenced by uiexception.UiException.getUIMessage(), and KERNEL_PY.kernel.uiexception.UiException.getUIMessage().

TYPES

uiexception.UiException.TYPES

static

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
    ])

Referenced by uiexception.UiException.setType(), and KERNEL_PY.kernel.uiexception.UiException.setType().