Dataflow Runtime API  3.0.1.0
Classes | Public Types | Static Public Member Functions | List of all members
imt::base::core::diagnostics::AssertActionManager Class Reference

The AssertActionManager defines some events called AssertActionEvents for which functions can be registered. More...

#include <Imt.Base.Core.Diagnostics/AssertActionManager.h>

Classes

struct  AssertEvent
 Defines different assert action events. More...
 

Public Types

typedef void(* AssertActionHandler) (const AssertEvent::Id actionEvent, const char_t *const pMessage)
 Define the prototype of a function which can handle an action event. More...
 

Static Public Member Functions

static void initActionManager (void)
 Initialize the AssertActionManager. More...
 
static AssertActionHandler registerActionHandler (const AssertActionHandler handler, const AssertEvent::Id actionEvent)
 Register a new handler for a specific event. More...
 
static void fireAssert (const AssertEvent::Id actionEvent, const char_t *const pMessage)
 Fire the assertion. More...
 

Detailed Description

The AssertActionManager defines some events called AssertActionEvents for which functions can be registered.

When the corresponding event occurs the registered function will be called. The AssertActionManager will be used from the assertion macros in Diagnostics.h and DiagnosticsConfigApp.h The later is application dependent.

Member Typedef Documentation

◆ AssertActionHandler

typedef void(* imt::base::core::diagnostics::AssertActionManager::AssertActionHandler) (const AssertEvent::Id actionEvent, const char_t *const pMessage)

Define the prototype of a function which can handle an action event.

Such a function can be registered for a particular AssertActionEvent. When such a AssertActionEvent occurs the function will be called

Parameters
actionEventThe event that has occurred. A function may handles multiple events.
pMessageOptional message

Member Function Documentation

◆ fireAssert()

static void imt::base::core::diagnostics::AssertActionManager::fireAssert ( const AssertEvent::Id  actionEvent,
const char_t *const  pMessage 
)
static

Fire the assertion.

Parameters
actionEventAssertEvent
pMessageOptional message which contains further information for the event

◆ initActionManager()

static void imt::base::core::diagnostics::AssertActionManager::initActionManager ( void  )
static

Initialize the AssertActionManager.

◆ registerActionHandler()

static AssertActionHandler imt::base::core::diagnostics::AssertActionManager::registerActionHandler ( const AssertActionHandler  handler,
const AssertEvent::Id  actionEvent 
)
static

Register a new handler for a specific event.

Parameters
handlerHandler to be registered. Must not be NULL
actionEventEvent for which the handler will be registered
Returns
The former AssertActionHandler
See also
LogEvent

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