ImpactAcquireException Class Reference

A base class for exceptions generated by Impact Acquire. More...

Inheritance diagram for ImpactAcquireException:

Public Member Functions
	__getitem__ (self, index)
	__init__ (self, errorString, errorOrigin, errorCode)
	Constructs a new mvIMPACT.acquire.ImpactAcquireException object.
	__str__ (self)
	getArgs (self)
	getErrorCode (self)
	Returns a unique numerical representation for this error.
	getErrorOrigin (self)
	Returns information about the origin of the error.
	getErrorString (self)
	Returns an error string containing information about the reason for the error.

Static Public Member Functions
	getErrorCodeAsString (*args)
	Returns a string representation of the error associated with the exception.

Properties
	args = property (lib_mvIMPACT_acquire.ImpactAcquireException_getArgs, None, None, None)
	errorCode = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorCode, None, None, None)
	Returns a unique numerical representation for this error.
	errorCodeAsString = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorCodeAsString, None, None, None)
	Returns a string representation of the error associated with the exception.
	errorOrigin = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorOrigin, None, None, None)
	Returns information about the origin of the error.
	errorString = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorString, None, None, None)
	Returns an error string containing information about the reason for the error.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

A base class for exceptions generated by Impact Acquire.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			errorString,
			errorOrigin,
			errorCode )

Constructs a new mvIMPACT.acquire.ImpactAcquireException object.

Parameters

errorString	[in] The string representation of the error.
errorOrigin	[in] The origin of the error (function name and line)
errorCode	[in] The numerical representation of the error.

Member Function Documentation

__getitem__()

__getitem__	(		self,
			index )

__str__()

__str__

(

self

)

getArgs()

getArgs

(

self

)

getErrorCode()

getErrorCode

(

self

)

Returns a unique numerical representation for this error.

getErrorCodeAsString()

getErrorCodeAsString ( * args )

static

Returns a string representation of the error associated with the exception.

OVERLOAD 1:

This function will return the name of the enum of the error code.

EXAMPLE

In case of error -2102 this function would return mvIMPACT.acquire.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

OVERLOAD 2: Returns a string representation of a error.

This function will return the name of the enum of the error code.

EXAMPLE

In case of error -2102 this function would return mvIMPACT.acquire.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

Parameters

errorCode

[in] The error code to query a string representation for.

getErrorOrigin()

getErrorOrigin

(

self

)

Returns information about the origin of the error.

The string returned by this function will contain the name of the function and the line number where the exception was raised.

getErrorString()

getErrorString

(

self

)

Returns an error string containing information about the reason for the error.

Property Documentation

args

args = property (lib_mvIMPACT_acquire.ImpactAcquireException_getArgs, None, None, None)

static

errorCode

errorCode = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorCode, None, None, None)

static

Returns a unique numerical representation for this error.

errorCodeAsString

errorCodeAsString = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorCodeAsString, None, None, None)

static

Returns a string representation of the error associated with the exception.

This function will return the name of the enum of the error code.

EXAMPLE In case of error -2102 this function would return mvIMPACT.acquire.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

errorOrigin

errorOrigin = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorOrigin, None, None, None)

static

Returns information about the origin of the error.

The string returned by this function will contain the name of the function and the line number where the exception was raised.

errorString

errorString = property (lib_mvIMPACT_acquire.ImpactAcquireException_getErrorString, None, None, None)

static

Returns an error string containing information about the reason for the error.

thisown

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

static