qevent.h File Reference

QEvent class and basic macros used by all QP components. More...

Go to the source code of this file.

Data Structures
struct	QEvent
	Event structure. More...
Defines
#define	QP_VERSION   0x4103
	The current QP version number.
#define	Q_DIM(array_)   (sizeof(array_) / sizeof(array_[0]))
Typedefs
typedef uint8_t	QSignal
	QSignal represents the signal of an event.

---

Detailed Description

QEvent class and basic macros used by all QP components.

This header file must be included, perhaps indirectly, in all modules (*.c files) that use any component of QP/C (such as QEP, QF, or QK).

Definition in file qevent.h.

---

Define Documentation

#define Q_DIM

(

array_

)

(sizeof(array_) / sizeof(array_[0]))

helper macro to calculate static dimension of a 1-dim array array_

Definition at line 157 of file qevent.h.

Referenced by QF_poolInit(), and QF_publish().

#define QP_VERSION   0x4103

The current QP version number.

Returns:

version of the QP as a hex constant constant 0xXYZZ, where X is a 1-digit major version number, Y is a 1-digit minor version number, and ZZ is a 2-digit release number.

Definition at line 47 of file qevent.h.

Referenced by QEP_getVersion(), QF_getVersion(), QK_getVersion(), and QS_getVersion().

---

Typedef Documentation

typedef uint8_t QSignal

QSignal represents the signal of an event.

The relationship between an event and a signal is as follows. A signal in UML is the specification of an asynchronous stimulus that triggers reactions [UML document ptc/03-08-02], and as such is an essential part of an event. (The signal conveys the type of the occurrence-what happened?) However, an event can also contain additional quantitative information about the occurrence in form of event parameters. Please refer to the document Brief Introduction to UML State Machines) for more information about state machine concepts.

Definition at line 128 of file qevent.h.