ImpactAcquireException Class Reference

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

Inheritance diagram for ImpactAcquireException:

Public Member Functions
synchronized void	delete ()
int	getErrorCode ()
	Returns a unique numerical representation for this error.
String	getErrorCodeAsString ()
	Returns a string representation of the error associated with the exception.
String	getErrorOrigin ()
	Returns information about the origin of the error.
String	getErrorString ()
	Returns an error string containing information about the reason for the error.
String	getMessage ()
	ImpactAcquireException (String errorString, String errorOrigin, int errorCode)
	Constructs a new mvIMPACT.acquire.ImpactAcquireException object.

Static Public Member Functions
static String	getErrorCodeAsString (int errorCode)
	Returns a string representation of a error.

Protected Member Functions
void	finalize ()
	ImpactAcquireException (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ImpactAcquireException obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A base class for exceptions generated by Impact Acquire.

Constructor & Destructor Documentation

ImpactAcquireException() [1/2]

ImpactAcquireException ( long cPtr, boolean cMemoryOwn )

protected

ImpactAcquireException() [2/2]

ImpactAcquireException	(	String	errorString,
		String	errorOrigin,
		int	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

delete()

synchronized void delete

(

)

Reimplemented in ECantAccessData, ECantAllocateNewList, ECantRegisterComponent, ECantSerializeData, EComponent, EComponentIDInvalid, EComponentNotFound, EDeviceManager, EImplementationMissing, EIncompatibleComponents, EInputBufferTooSmall, EInvalidFileContent, EInvalidInputParameter, EInvalidListID, EInvalidParameterList, EInvalidValue, EInvalidValueType, EListEntryOccupied, EMethod, EMethodPtrInvalid, ENoModifySizeRights, ENoReadRights, ENotAList, ENotAMethod, ENotAProperty, ENoWriteRights, EProperty, EPropertyHandling, EPropertyList, ESizeMismatch, ETranslationTableCorrupted, ETranslationTableNotDefined, EUnsupportedOperation, EUnsupportedParameter, EValidationFailed, EValIDOutOfBounds, EValTooLarge, EValTooSmall, and EWrongParamCount.

finalize()

void finalize ( )

protected

Reimplemented in ECantAccessData, ECantAllocateNewList, ECantRegisterComponent, ECantSerializeData, EComponentIDInvalid, EComponentNotFound, EDeviceManager, EImplementationMissing, EIncompatibleComponents, EInputBufferTooSmall, EInvalidFileContent, EInvalidInputParameter, EInvalidListID, EInvalidParameterList, EInvalidValue, EInvalidValueType, EListEntryOccupied, EMethodPtrInvalid, ENoModifySizeRights, ENoReadRights, ENotAList, ENotAMethod, ENotAProperty, ENoWriteRights, EPropertyHandling, ESizeMismatch, ETranslationTableCorrupted, ETranslationTableNotDefined, EUnsupportedOperation, EUnsupportedParameter, EValidationFailed, EValIDOutOfBounds, EValTooLarge, EValTooSmall, and EWrongParamCount.

getErrorCode()

int getErrorCode

(

)

Returns a unique numerical representation for this error.

getErrorCodeAsString() [1/2]

String getErrorCodeAsString

(

)

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.TDMR_ERROR.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

getErrorCodeAsString() [2/2]

static String getErrorCodeAsString ( int errorCode )

static

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.TDMR_ERROR.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()

String getErrorOrigin

(

)

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

String getErrorString

(

)

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

getMessage()

String getMessage

(

)

swigRelease()

static long swigRelease ( ImpactAcquireException obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protected