Class Spinnaker::Exception¶

ClassList > Spinnaker > Exception

The Exception object represents an error that is returned from the library. Overloaded operators allow comparisons against otherException objects.

#include <Exception.h>

Inherits the following classes: std::exception

Public Functions¶

Type	Name
	Exception ()
	Exception (int line, const char * fileName, const char * funcName, const char * errMsg, Error err)
	Exception (int line, const char * fileName, const char * funcName, const char * buildDate, const char * buildTime, const char * errMsg, Error err)
	Exception (const Exception & except)
const char *	GetBuildDate () const
const char *	GetBuildTime () const
Error	GetError () const
const char *	GetErrorMessage () const
const char *	GetFileName () const
const char *	GetFullErrorMessage () const
const char *	GetFunctionName () const
int	GetLineNumber () const
bool	operator!= (const Error err) const
Exception &	operator= (const Exception & except)
bool	operator== (const Error err) const
virtual const char *	what () const
virtual	~Exception ()

Public Functions Documentation¶

function Exception [1/4]¶

Spinnaker::Exception::Exception ()

Default constructor.

function Exception [2/4]¶

Spinnaker::Exception::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

function Exception [3/4]¶

Spinnaker::Exception::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

function Exception [4/4]¶

Spinnaker::Exception::Exception (
    const Exception & except
)

Copy constructor.

function GetBuildDate¶

const char * Spinnaker::Exception::GetBuildDate () const

function GetBuildTime¶

const char * Spinnaker::Exception::GetBuildTime () const

function GetError¶

Error Spinnaker::Exception::GetError () const

function GetErrorMessage¶

const char * Spinnaker::Exception::GetErrorMessage () const

Accessor Functions.

function GetFileName¶

const char * Spinnaker::Exception::GetFileName () const

function GetFullErrorMessage¶

const char * Spinnaker::Exception::GetFullErrorMessage () const

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

function GetFunctionName¶

const char * Spinnaker::Exception::GetFunctionName () const

function GetLineNumber¶

int Spinnaker::Exception::GetLineNumber () const

function operator!=¶

bool Spinnaker::Exception::operator!= (
    const Error err
) const

Inequality operator.

function operator=¶

Exception & Spinnaker::Exception::operator= (
    const Exception & except
)

Assignment operator.

function operator==¶

bool Spinnaker::Exception::operator== (
    const Error err
) const

Equality operator.

function what¶

virtual const char * Spinnaker::Exception::what () const

virtual override for what(). Gets the error code and error message.

function ~Exception¶

virtual Spinnaker::Exception::~Exception ()

Default destructor.

The documentation for this class was generated from the following file C:/workspace/include/Exception.h