HErrorManager Class Reference

The HErrorManager class handles all the error messaging in MVO. More...

#include <HErrorManager.h>

Static Public Member Functions

static void AllowAllErrors ()
 
static void BeginErrorIteration ()
 
static void CallbackEntryPoint (int category, int specific, int severity, int msgc, char const *msgv[], int stackc, char const *stackv[])
 
static void Cleanup ()
 
static void DeleteLastError ()
 
static void Flush ()
 
static bool GetDialogRunning ()
 
static HErrorNodeGetLastError ()
 
static HErrorNodeGetNextError ()
 
static bool GetShowDialog ()
 
static void Init ()
 
static void SetErrorCallback (void(*err)(HErrorNode *, void *), void *user_data)
 
static void SetShowDialog (bool s)
 
static void SetSpoolUpdateErrors (bool s)
 
static void ShowAllErrors ()
 
static void SpoolUpdateErrors ()
 
static void SuppressError (int severity, int category, int specific)
 

Detailed Description

The HErrorManager class handles all the error messaging in MVO.

Member Function Documentation

◆ AllowAllErrors()

static void HErrorManager::AllowAllErrors ( )
static

This method sets the system option to turn on all error, warning and information messages. It also clear the suppress errors list.

◆ BeginErrorIteration()

static void HErrorManager::BeginErrorIteration ( )
static

This method prepares the error handler for iteration through the error list. Call this method before making calls to GetNextError.

◆ CallbackEntryPoint()

static void HErrorManager::CallbackEntryPoint ( int  category,
int  specific,
int  severity,
int  msgc,
char const *  msgv[],
int  stackc,
char const *  stackv[] 
)
static

This is the callback function that handles the errors that are generated putting the in the correct error list. Note that when Update errors are received they are not immediately put in the error list and displayed. They are put in an update error list because error messages cannot be displayed while an update is occurring. When the update is finished, call SpoolUpdateError to move the update errors into the main error list to be displayed.

Parameters
severityAn integer that defines the seriousness of the error as described in #HC_Define_Error_Handler.
categeoryAn integer that dentifies the general category the error belongs to as described in #HC_Define_Error_Handler. For example, memory errors fall in the HEC_MEMORY error category.
specificAn integer that identifies the specific error under the category already defined as described in #HC_Define_Error_Handler. For example, running out of memory, HES_OUT_OF_MEMORY, is a specific memory error in the
HEC_MEMORY category.
msgcThe length of the msgv array.
msgvAn array of pointers to a list of messages.
stackcThe length of stackv.
stackvAn array of strings that indicates the list of methods that were called. The last being the currently active HOOPS routine and the first being the originating function.

◆ Cleanup()

static void HErrorManager::Cleanup ( )
static

This method cleans up the error and suppression list and unregisters all callbacks.

◆ DeleteLastError()

static void HErrorManager::DeleteLastError ( )
static

This method remove the last error message from the error list and deletes it.

◆ Flush()

static void HErrorManager::Flush ( )
static

This method removes all the errors from the mail error list and the update error list.

◆ GetDialogRunning()

static bool HErrorManager::GetDialogRunning ( )
inlinestatic
Returns
True if the error dialog is currently running or false if it isn't.

◆ GetLastError()

static HErrorNode* HErrorManager::GetLastError ( )
static
Returns
A pointer to the last error message that was generated.

◆ GetNextError()

static HErrorNode* HErrorManager::GetNextError ( )
static
Returns
A pointer to the next error message in the error list.

◆ GetShowDialog()

static bool HErrorManager::GetShowDialog ( )
inlinestatic
Returns
True if HOOPS will show an error dialog or false if it will not.

◆ Init()

static void HErrorManager::Init ( )
static

This method initialized the error and suppression lists as well as registers the callback that handles errors that are generated by the HOOPS database.

◆ SetErrorCallback()

static void HErrorManager::SetErrorCallback ( void(*)(HErrorNode *, void *)  err,
void *  user_data 
)
inlinestatic

This method sets the event checker callback.

◆ SetShowDialog()

static void HErrorManager::SetShowDialog ( bool  s)
inlinestatic

This method sets the show dialog member variable.

Parameters
sPass true to show the error dialor or false not to show it.

◆ SetSpoolUpdateErrors()

static void HErrorManager::SetSpoolUpdateErrors ( bool  s)
inlinestatic

This method had not been implemented yet.

◆ ShowAllErrors()

static void HErrorManager::ShowAllErrors ( )
static

This method iterates through all the messages the error list and displays them to the user.

◆ SpoolUpdateErrors()

static void HErrorManager::SpoolUpdateErrors ( )
static

This method iterates through the update error list which holds errors associated with #HC_Update_Display and adds those errors that should not be suppress to the main error list. Note that no errors messages can be displayed during an update. Call this method after an update has occurred to ensure that an errors that were generated during an update will be displayed.

◆ SuppressError()

static void HErrorManager::SuppressError ( int  severity,
int  category,
int  specific 
)
static

This method takes a given the severity, category and specific and uses this combination to suppress errors that have the corresponding values.

Parameters
severityAn integer that defines the seriousness of the error as described in #HC_Define_Error_Handler.
categeoryAn integer that dentifies the general category the error belongs to as described in #HC_Define_Error_Handler. For example, memory errors fall in the HEC_MEMORY error category.
specificAn integer that identifies the specific error under the category already defined as described in #HC_Define_Error_Handler. For example, running out of memory, HES_OUT_OF_MEMORY, is a specific memory error in the
HEC_MEMORY category.

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