EPropertyHandling Class Reference

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

#include <mvIMPACT_acquire.h>

Inheritance diagram for EPropertyHandling:

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

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

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

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

inlineexplicit

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

Parameters

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

~EPropertyHandling()

virtual ~EPropertyHandling ( ) throw (  )

inlinevirtual

Member Function Documentation

getErrorCode()

int getErrorCode ( void ) const

inlineinherited

Returns a unique numerical representation for this error.

Examples

Callback.cpp, CaptureToOpenGLMemory.cpp, CaptureToUserMemory.cpp, CaptureToUserMemory.legacy.cpp, ContinuousCapture.linux.cpp, ContinuousCaptureAllDevices.cpp, ContinuousCaptureAllDevices.linux.cpp, ContinuousCaptureAllDevices.win32.cpp, ContinuousCaptureDirectX.cpp, ContinuousCaptureToAVIFile.cpp, GenICamI2cUsage.cpp, GenericInterfaceLayout.cpp, GenericInterfaceLayout.legacy.cpp, Properties.cpp, Properties.legacy.cpp, SingleCapture.cpp, and SingleCaptureStorage.cpp.

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]

errorCode

The error code to query a string representation for.

getErrorCodeAsString() [2/2]

std::string getErrorCodeAsString ( void ) const

inlineinherited

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.

Examples

CaptureToMegaBuffer.cpp, CaptureToOpenGLMemory.cpp, CaptureToUserMemory.cpp, CaptureToUserMemory.legacy.cpp, ContinuousCapture.cpp, ContinuousCapture.linux.cpp, ContinuousCapture.win32.cpp, ContinuousCaptureAllDevices.cpp, ContinuousCaptureAllDevices.linux.cpp, ContinuousCaptureAllDevices.win32.cpp, ContinuousCaptureAllFormats.cpp, ContinuousCaptureAllFormats.win32.cpp, ContinuousCaptureFFmpeg.cpp, ContinuousCaptureMultiPart.cpp, ContinuousCaptureMultiPart.legacy.cpp, ContinuousCaptureOnlyProcessLatest.cpp, ContinuousCaptureOnlyProcessLatest.legacy.cpp, DigitalIOs.cpp, DigitalIOs.legacy.cpp, FirmwareUpdate.cpp, GenICamCallbackOnEvent.cpp, GenICamCommonSettingsUsage.cpp, GenICamCommonSettingsUsage.legacy.cpp, GenICamI2cUsage.cpp, GenICamInterfaceLayout.cpp, GenICamInterfaceLayout.legacy.cpp, GenICamSequencerParameterChangeAtRuntime.cpp, GenICamSequencerUsage.cpp, GenICamSequencerUsage.legacy.cpp, GenICamSequencerUsageWithPaths.cpp, GenICamSequencerUsageWithPaths.legacy.cpp, GenICamSmartFrameRecallUsage.cpp, GenICamSmartFrameRecallUsage.legacy.cpp, GigEVisionActionFeatures.cpp, SequenceCapture.cpp, SequenceCapture.win32.cpp, SingleCaptureMasterSlave.cpp, SingleCaptureMasterSlave.legacy.cpp, TimestampFeatures.cpp, and exampleHelper.h.

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

ContinuousCaptureToAVIFile.cpp, GigEVisionActionFeatures.cpp, and exampleHelper.h.