ErrorHandler Class Reference

ErrorHandler, default constructor.

Definition at line 5 of file ErrorHandler.cpp.

ErrorHandler, constructor taking a few inputs.

This constuctor takes a few inputs, to enable more functionality

Parameters:

batteryvoltage	A string pointer, enabling the class to access the current battery voltage string
fix	A bool pointer, pointing to a boolean flag with gps fix status
bmag	A BMAG object pointer, enabling the access to mag data directly from this class
gps	An NMEA object pointer to a gps in this case

Definition at line 24 of file ErrorHandler.cpp.

getErrorState is a method returning the current errorstate

Returns the current errorstate

Returns:

currentState The current ErrorState

Definition at line 163 of file ErrorHandler.cpp.

getLine1 is an error string getter method

This method returns the first row of input used in a display

Returns:

errorStr1 a string containing the first display row

Definition at line 44 of file ErrorHandler.cpp.

getLine2 is an error string getter method

This method returns the second row of input used in a display

Returns:

errorStr2 a string containing the second display row

Definition at line 55 of file ErrorHandler.cpp.

getMagTimePromtStatus is a prompt status flag getter method

Returns the status of the setMagTimePrompted flag, indicating if a "please set the clock on bmag" prompt has been shown on display.

Returns:

setMagTimePrompted A bool indicating if user has been prompted to set time on mag or not.

Definition at line 153 of file ErrorHandler.cpp.

setErrorState is a error state setter method.

Used to set the current errorstate, and changing the display texts accordingly

Parameters:

es	The errorstate needed of type ErrorState

Definition at line 66 of file ErrorHandler.cpp.