Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
Exception Class Reference

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

Inheritance diagram for Exception:

Public Member Functions

 Exception ()
 Default constructor. More...
 
 Exception (int line, const char *fileName, const char *funcName, const char *errMsg, Error err)
 Message constructor. More...
 
 Exception (int line, const char *fileName, const char *funcName, const char *buildDate, const char *buildTime, const char *errMsg, Error err)
 Message constructor. More...
 
 Exception (const Exception &except)
 Copy constructor. More...
 
virtual ~Exception () throw ()
 Default destructor. More...
 
Exceptionoperator= (const Exception &except)
 Assignment operator. More...
 
bool operator== (const Error err) const
 Equality operator. More...
 
bool operator!= (const Error err) const
 Inequality operator. More...
 
virtual const char * what () const throw ()
 virtual override for what(). More...
 
const char * GetFullErrorMessage () const
 Gets the error code and full error message including the line, file, function, build date, and time. More...
 
const char * GetErrorMessage () const
 Accessor Functions. More...
 
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, AcquisitionMultipleThread.cpp, ActionCommand.cpp, BufferHandling.cpp, ChunkData.cpp, Compression.cpp, CounterAndTimer.cpp, DeviceEvents.cpp, Enumeration.cpp, Enumeration_QuickSpin.cpp, EnumerationEvents.cpp, ExceptionHandling.cpp, Exposure.cpp, Exposure_QuickSpin.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageEvents.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, LookupTable.cpp, NodeMapCallback.cpp, NodeMapInfo.cpp, Polarization.cpp, SaveToAvi.cpp, Sequencer.cpp, SerialRxTx.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

Exception ( )

Default constructor.

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

Message constructor.

Parameters
lineLine number where the exception is thrown
fileNameName of the file called
funcNameName of the function called
errMsgA pointer to the exception message string
errError code
Exception ( int  line,
const char *  fileName,
const char *  funcName,
const char *  buildDate,
const char *  buildTime,
const char *  errMsg,
Error  err 
)

Message constructor.

Parameters
lineLine number where the exception is thrown
fileNameName of the file called
funcNameName of the function called
buildDateBuild date
buildTimeBuild time
errMsgA pointer to the exception message string
errError code
Exception ( const Exception except)

Copy constructor.

virtual ~Exception ( )
throw (
)
virtual

Default destructor.

Member Function Documentation

const char* GetBuildDate ( ) const
const char* GetBuildTime ( ) const
Error GetError ( ) const
const char* GetErrorMessage ( ) const

Accessor Functions.

Examples:
ExceptionHandling.cpp, and GigEVisionPerformance.cpp.
const char* GetFileName ( ) const
const char* GetFullErrorMessage ( ) const

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

const char* GetFunctionName ( ) const
int GetLineNumber ( ) const
bool operator!= ( const Error  err) const

Inequality operator.

Exception& operator= ( const Exception except)

Assignment operator.

bool operator== ( const Error  err) const

Equality operator.

virtual const char* what ( ) const
throw (
)
virtual

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference