mvIMPACT Acquire SDK C++
ImpactAcquireException Class Reference

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

Inheritance diagram for ImpactAcquireException:
EDeviceManager EPropertyHandling ECantAllocateNewList ECantSerializeData EComponent EImplementationMissing EInputBufferTooSmall EInvalidFileContent EInvalidInputParameter ESizeMismatch EUnsupportedOperation EUnsupportedParameter EWrongParamCount

Public Member Functions

int getErrorCode (void) const
 Returns a unique numerical representation for this error. More...
 
std::string getErrorCodeAsString (void) const
 Returns a string representation of the error associated with the exception. More...
 
std::string getErrorOrigin (void) const
 Returns information about the origin of the error. More...
 
std::string getErrorString (void) const
 Returns an error string containing information about the reason for the error. More...
 
 ImpactAcquireException (const std::string &errorString, const std::string &errorOrigin, int errorCode)
 Constructs a new mvIMPACT::acquire::ImpactAcquireException object. More...
 
virtual ~ImpactAcquireException () throw ()
 

Static Public Member Functions

static std::string getErrorCodeAsString (int errorCode)
 Returns a string representation of a error. More...
 

Detailed Description

A base class for exceptions generated by mvIMPACT Acquire.

Examples
exampleHelper.h.

Constructor & Destructor Documentation

◆ ImpactAcquireException()

ImpactAcquireException ( const std::string &  errorString,
const std::string &  errorOrigin,
int  errorCode 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::ImpactAcquireException object.

Parameters
[in]errorStringThe string representation of the error.
[in]errorOriginThe origin of the error (function name and line)
[in]errorCodeThe numerical representation of the error.

◆ ~ImpactAcquireException()

virtual ~ImpactAcquireException ( )
throw (
)
inlinevirtual

Member Function Documentation

◆ getErrorCode()

int getErrorCode ( void  ) const
inline

Returns a unique numerical representation for this error.

◆ getErrorCodeAsString() [1/2]

static std::string getErrorCodeAsString ( int  errorCode)
inlinestatic

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
[in]errorCodeThe error code to query a string representation for.

◆ getErrorCodeAsString() [2/2]

◆ getErrorOrigin()

std::string getErrorOrigin ( void  ) const
inline

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

std::string getErrorString ( void  ) const
inline

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

Examples
exampleHelper.h.

The documentation for this class was generated from the following file: