mvIMPACT Acquire SDK C++
EPropertyList Class Reference

A base class for component list related exceptions from the property module. More...

Inheritance diagram for EPropertyList:
EComponent EPropertyHandling ImpactAcquireException ECantAccessData ECantRegisterComponent EComponentIDInvalid EComponentNotFound EInvalidListID EListEntryOccupied

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...
 

Static Public Member Functions

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

Protected Member Functions

 EPropertyList (const std::string &errorString, const std::string &errorOrigin, TPROPHANDLING_ERROR errorCode)
 Creates a new mvIMPACT::acquire::EPropertyList object. More...
 
virtual ~EPropertyList () throw ()
 

Detailed Description

A base class for component list related exceptions from the property module.

This exception object will never be raised in the code. It can't be constructed directly but to check for component list related errors a catch block for mvIMPACT::acquire::EPropertyList objects can be written to catch all exceptions related to lists and list operations.

Constructor & Destructor Documentation

◆ EPropertyList()

EPropertyList ( const std::string &  errorString,
const std::string &  errorOrigin,
TPROPHANDLING_ERROR  errorCode 
)
inlineexplicitprotected

Creates a new mvIMPACT::acquire::EPropertyList object.

Parameters
[in]errorStringThe error string.
[in]errorOriginThe error origin.
[in]errorCodeThe error code.

◆ ~EPropertyList()

virtual ~EPropertyList ( )
throw (
)
inlineprotectedvirtual

Member Function Documentation

◆ getErrorCode()

int getErrorCode ( void  ) const
inlineinherited

Returns a unique numerical representation for this error.

◆ getErrorCodeAsString() [1/2]

static std::string getErrorCodeAsString ( int  errorCode)
inlinestaticinherited

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
inlineinherited

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
inlineinherited

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: