ImpactAcquireException Class Reference

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

#include <mvIMPACT_acquire.h>

Inheritance diagram for ImpactAcquireException:

Public Member Functions
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.
	ImpactAcquireException (const std::string &errorString, const std::string &errorOrigin, int errorCode)
	Constructs a new mvIMPACT::acquire::ImpactAcquireException object.
virtual	~ImpactAcquireException () 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 generated by Impact Acquire.

Examples

Callback.cpp, CaptureToMegaBuffer.cpp, CaptureToOpenGLMemory.cpp, CaptureToUserMemory.cpp, ContinuousCapture.cpp, ContinuousCaptureAllDevices.cpp, ContinuousCaptureAllFormats.cpp, ContinuousCaptureDirectX.cpp, ContinuousCaptureFFmpeg.cpp, ContinuousCaptureGenDC.cpp, ContinuousCaptureMultiPart.cpp, ContinuousCaptureOnlyProcessLatest.cpp, ContinuousCaptureToAVIFile.cpp, ContinuousCapture_BVS-3D-RV1.cpp, DigitalIOs.cpp, FirmwareUpdate.cpp, GenICamCallbackOnEvent.cpp, GenICamCommonSettingsUsage.cpp, GenICamI2cUsage.cpp, GenICamInterfaceLayout.cpp, GenICamSequencerParameterChangeAtRuntime.cpp, GenICamSequencerUsage.cpp, GenICamSequencerUsageWithPaths.cpp, GenICamSmartFrameRecallUsage.cpp, GenericInterfaceLayout.cpp, GigEVisionActionFeatures.cpp, Properties.cpp, SequenceCapture.cpp, SingleCapture.cpp, SingleCaptureMasterSlave.cpp, SingleCaptureStorage.cpp, TimestampFeatures.cpp, and 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]	errorString	The string representation of the error.
[in]	errorOrigin	The origin of the error (function name and line)
[in]	errorCode	The 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.

Examples

Callback.cpp, CaptureToOpenGLMemory.cpp, CaptureToUserMemory.cpp, ContinuousCaptureAllDevices.cpp, ContinuousCaptureDirectX.cpp, ContinuousCaptureToAVIFile.cpp, ContinuousCapture_BVS-3D-RV1.cpp, GenICamI2cUsage.cpp, GenericInterfaceLayout.cpp, Properties.cpp, SingleCapture.cpp, and SingleCaptureStorage.cpp.

getErrorCodeAsString() [1/2]

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]

errorCode

The error code to query a string representation for.

getErrorCodeAsString() [2/2]

std::string getErrorCodeAsString ( void ) const

inline

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, ContinuousCapture.cpp, ContinuousCaptureAllDevices.cpp, ContinuousCaptureAllFormats.cpp, ContinuousCaptureDirectX.cpp, ContinuousCaptureFFmpeg.cpp, ContinuousCaptureGenDC.cpp, ContinuousCaptureMultiPart.cpp, ContinuousCaptureOnlyProcessLatest.cpp, ContinuousCaptureToAVIFile.cpp, DigitalIOs.cpp, FirmwareUpdate.cpp, GenICamCallbackOnEvent.cpp, GenICamCommonSettingsUsage.cpp, GenICamI2cUsage.cpp, GenICamInterfaceLayout.cpp, GenICamSequencerParameterChangeAtRuntime.cpp, GenICamSequencerUsage.cpp, GenICamSequencerUsageWithPaths.cpp, GenICamSmartFrameRecallUsage.cpp, GenericInterfaceLayout.cpp, GigEVisionActionFeatures.cpp, Properties.cpp, SequenceCapture.cpp, SingleCaptureMasterSlave.cpp, TimestampFeatures.cpp, and exampleHelper.h.

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

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