Notification Struct Reference

A tagged union representing either a system or user-defined notification. More...

#include <Notification.h>

Collaboration diagram for Notification:

Public Member Functions
	Notification ()
	Default constructor initializes to a system notification of None.
	Notification (SystemNotification s)
	Construct a Notification with a specific system notification type.
	Notification (uint8_t userCode)
	Construct a Notification with a user-defined code.
uint8_t	code () const
	Get the notification code.

Public Attributes
NotificationKind	kind
union {
SystemNotification   system
uint8_t   user_code
};

Detailed Description

Definition at line 38 of file Notification.h.

Constructor & Destructor Documentation

Notification() [1/3]

Notification::Notification ( )

inline

Use the other constructors to specify a system or user notification.

Definition at line 50 of file Notification.h.

: kind(NotificationKind::System), system(SystemNotification::None) {}

Notification() [2/3]

Notification::Notification ( SystemNotification  s )

inline

Parameters

s	The system notification type.

Definition at line 57 of file Notification.h.

: kind(NotificationKind::System), system(s) {}

Notification() [3/3]

Notification::Notification ( uint8_t  userCode )

inline

Parameters

userCode

The user-defined notification code.

Definition at line 64 of file Notification.h.

: kind(NotificationKind::User), user_code(userCode) {}

Member Function Documentation

code()

uint8_t Notification::code ( ) const

inline

If it's a system notification, returns the system code. If it's a user notification, returns the user-defined code.

Returns

uint8_t The notification code.

Definition at line 73 of file Notification.h.

                         {
        return (kind == NotificationKind::System)
            ? static_cast<uint8_t>(system)
            : user_code;
    }

References kind, System, system, and user_code.

Referenced by FrameworkTask::notify(), FrameworkTask::notifyFromISR(), EventManager::postNotification(), TimerService::scheduleDailyAt(), TimerService::scheduleDuration(), TimerService::scheduleEvery(), and FrameworkTask::waitFor().

Here is the caller graph for this function:

Member Data Documentation

[union]

union { ... } Notification

kind

NotificationKind Notification::kind

Definition at line 39 of file Notification.h.

Referenced by code(), Event::isSystem(), Event::isUser(), App::onEvent(), FrameworkManager::onEvent(), and FrameworkTask::waitForAny().

system

SystemNotification Notification::system

Definition at line 42 of file Notification.h.

Referenced by code(), App::onEvent(), FrameworkManager::onEvent(), Event::systemCode(), and FrameworkTask::waitForAny().

user_code

uint8_t Notification::user_code

Definition at line 43 of file Notification.h.

Referenced by code(), App::onEvent(), and Event::userCode().

---

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

• Notification.h