Package esys :: Package lsm :: Package vis :: Package core :: Module exception

Module exception

Defines helper function raiseNotImplemented for raising an exception in abstract methods of base classes.

Functions

bool

raiseExceptionWhenNotImplemented(doRaise=None)
Return value of this function used in raiseNotImplemented.

raiseNotImplemented(msg='', logger=esys.lsm.Logging.getLogger("esys.lsm.vis.core"))
Raises a NotImplementedError exception and logs the back-trace using the specified logger.

Variables

[hide private]

_defaultLogger = esys.lsm.Logging.getLogger("esys.lsm.vis.core")

_doRaiseWhenNotImplemented = True

__package__ = 'esys.lsm.vis.core'

Function Details

[hide private]

raiseExceptionWhenNotImplemented(doRaise=None)

Return value of this function used in raiseNotImplemented.

Parameters:

doRaise (bool) - If specified, sets whether raiseNotImplemented is to raise an exception.

Returns: bool

True when raiseNotImplemented is to raise a NotImplementedError exception.

raiseNotImplemented(msg=`''`, logger=esys.lsm.Logging.getLogger("esys.lsm.vis.core"))

Raises a NotImplementedError exception and logs the back-trace using the specified logger. The exception is raised only if raiseExceptionWhenNotImplemented returns true, otherwise only the back-trace is logged and no exception is thrown.

Parameters:

msg (str) - Exception message string passed to NotImplementedError constructor.
logger (logging.Logger) - The Logger.error message is used to log the lines of a back-trace.

Module exception

raiseExceptionWhenNotImplemented(doRaise=None)

raiseNotImplemented(msg='', logger=esys.lsm.Logging.getLogger("esys.lsm.vis.core"))

raiseNotImplemented(msg=`''`, logger=esys.lsm.Logging.getLogger("esys.lsm.vis.core"))