Impact Acquire SDK Java
EPropertyHandling Class Reference

A base class for exceptions related to the property module. More...

Inheritance diagram for EPropertyHandling:
[legend]

Public Member Functions

synchronized void delete ()
 
 EPropertyHandling (String errorString, String errorOrigin, int errorCode)
 Creates a new mvIMPACT.acquire.EPropertyHandling object.
 
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 ()
 

Static Public Member Functions

static String getErrorCodeAsString (int errorCode)
 Returns a string representation of a error.
 

Protected Member Functions

 EPropertyHandling (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long swigRelease (EPropertyHandling obj)
 
static long swigRelease (ImpactAcquireException obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

A base class for exceptions related to the property module.

This exception object will only be raised if an unknown error occurred. To check for errors related to the property module a catch block for mvIMPACT.acquire.EPropertyHandling objects can be written to catch all property module related exceptions.

Constructor & Destructor Documentation

◆ EPropertyHandling() [1/2]

EPropertyHandling ( long cPtr,
boolean cMemoryOwn )
protected

◆ EPropertyHandling() [2/2]

EPropertyHandling ( String errorString,
String errorOrigin,
int errorCode )

Creates a new mvIMPACT.acquire.EPropertyHandling object.

Parameters
errorString[in] The error string.
errorOrigin[in] The error origin.
errorCode[in] The error code.

Member Function Documentation

◆ delete()

◆ finalize()

◆ getErrorCode()

int getErrorCode ( )
inherited

Returns a unique numerical representation for this error.

◆ getErrorCodeAsString() [1/2]

String getErrorCodeAsString ( )
inherited

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

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

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

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

◆ getMessage()

String getMessage ( )
inherited

◆ swigRelease() [1/2]

static long swigRelease ( EPropertyHandling obj)
staticprotected

◆ swigRelease() [2/2]

static long swigRelease ( ImpactAcquireException obj)
staticprotectedinherited

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited