Impact Acquire SDK Python
ExceptionFactory Class Reference

A factory class to raise Impact Acquire related exceptions. More...

Inheritance diagram for ExceptionFactory:
[legend]

Public Member Functions

 __init__ (self)
 

Static Public Member Functions

 getLastErrorString ()
 Returns the last error string that did occur inside the framework within the current thread.
 
 raiseException (*args)
 Raises an exception from an error code, its origin in terms of the function name and the line number the error did occur and an optional component handle.
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

A factory class to raise Impact Acquire related exceptions.

This class contains a collection of static member functions that are used inside the interface to raise the appropriate exception in case of an error

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self)

Member Function Documentation

◆ getLastErrorString()

getLastErrorString ( )
static

Returns the last error string that did occur inside the framework within the current thread.

Returns
The last error string that did occur inside the framework within the current thread.

◆ raiseException()

raiseException ( * args)
static

Raises an exception from an error code, its origin in terms of the function name and the line number the error did occur and an optional component handle.

OVERLOAD 1:

Parameters
pFunctionName[in] The name of the function this exception was raised from.
lineNumber[in] The line number in the source this exception was raised from.
errorCode[in] The error code.
objectHandle[in] A handle to an object.

OVERLOAD 2: Raises an exception from an error code, its origin in terms of the function name and the line number the error did occur and an exception string.

Parameters
pFunctionName[in] The name of the function this exception was raised from.
lineNumber[in] The line number in the source this exception was raised from.
errorCode[in] The error code.
msg[in] The actual exception text.

Property Documentation

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static