Exception Class Reference

The Exception object represents an error that is returned from the library. More...

#include <Exception.h>

Inheritance diagram for Exception:

Public Member Functions
	Exception ()
	Default constructor.
	Exception (int line, const char *fileName, const char *funcName, const char *errMsg, Error err)
	Message constructor.
	Exception (int line, const char *fileName, const char *funcName, const char *buildDate, const char *buildTime, const char *errMsg, Error err)
	Message constructor.
	Exception (const Exception &except)
	Copy constructor.
virtual	~Exception () throw ()
	Default destructor.
Exception &	operator= (const Exception &except)
	Assignment operator.
bool	operator== (const Error err) const
	Equality operator.
bool	operator!= (const Error err) const
	Inequality operator.
virtual const char *	what () const throw ()
	virtual override for what().
const char *	GetFullErrorMessage () const
	Gets the error code and full error message including the line, file, function, build date, and time.
const char *	GetErrorMessage () const
	Accessor Functions.
const char *	GetFileName () const
const char *	GetFunctionName () const
const char *	GetBuildDate () const
const char *	GetBuildTime () const
int	GetLineNumber () const
Error	GetError () const

Detailed Description

The Exception object represents an error that is returned from the library.

Overloaded operators allow comparisons against other Exception objects.

Examples

Acquisition.cpp, AcquisitionMultipleCameraRecovery.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, CounterAndTimer.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, SpinSimpleGUI_DirectShow.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

Exception() [1/4]

Exception

(

)

Default constructor.

Exception() [2/4]

Exception	(	int	line,
		const char *	fileName,
		const char *	funcName,
		const char *	errMsg,
		Error	err
	)

Message constructor.

Parameters

line	Line number where the exception is thrown
fileName	Name of the file called
funcName	Name of the function called
errMsg	A pointer to the exception message string
err	Error code

Exception() [3/4]

Exception	(	int	line,
		const char *	fileName,
		const char *	funcName,
		const char *	buildDate,
		const char *	buildTime,
		const char *	errMsg,
		Error	err
	)

Message constructor.

Parameters

line	Line number where the exception is thrown
fileName	Name of the file called
funcName	Name of the function called
buildDate	Build date
buildTime	Build time
errMsg	A pointer to the exception message string
err	Error code

Exception() [4/4]

Exception

(

const Exception &

except

)

Copy constructor.

~Exception()

virtual ~Exception ( ) throw ( )

virtual

Default destructor.

Member Function Documentation

GetBuildDate()

const char * GetBuildDate

(

)

const

GetBuildTime()

const char * GetBuildTime

(

)

const

GetError()

Error GetError

(

)

const

Examples

GigEVisionPerformance.cpp.

GetErrorMessage()

const char * GetErrorMessage

(

)

const

Accessor Functions.

Examples

GigEVisionPerformance.cpp.

GetFileName()

const char * GetFileName

(

)

const

GetFullErrorMessage()

const char * GetFullErrorMessage

(

)

const

Gets the error code and full error message including the line, file, function, build date, and time.

GetFunctionName()

const char * GetFunctionName

(

)

const

GetLineNumber()

int GetLineNumber

(

)

const

operator!=()

bool operator!=

(

const Error

err

)

const

Inequality operator.

operator=()

Exception & operator=

(

const Exception &

except

)

Assignment operator.

operator==()

bool operator==

(

const Error

err

)

const

Equality operator.

what()

virtual const char * what ( ) const throw ( )

virtual

virtual override for what().

Gets the error code and error message.

Examples

Acquisition.cpp, AcquisitionMultipleCameraRecovery.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, CounterAndTimer.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, SpinSimpleGUI_DirectShow.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

---

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

• include/Exception.h