QP/C  8.0.4
Real-Time Event Framework
Loading...
Searching...
No Matches
Macros | Typedefs
qpc.h File Reference

QP/C interface including the backwards-compatibility layer. More...

#include "qp_port.h"
#include "qsafe.h"
#include "qs_port.h"

Go to the source code of this file.

Macros

#define QP_API_VERSION   0
 
#define QM_SUPER_SUB(host_)
 
#define QM_TRAN_EP(tatbl_)
 
#define QM_TRAN_XP(xp_, tatbl_)
 
#define QACTIVE_START(me_, prioSpec_, qSto_, qLen_, stkSto_, stkSize_, par_)
 
#define QXTHREAD_START(me_, prioSpec_, qSto_, qLen_, stkSto_, stkSize_, par_)
 
#define Q_onAssert(module_, id_)
 
#define Q_ALLEGE_ID(id_, expr_)
 
#define Q_ALLEGE(expr_)
 
#define Q_ASSERT_COMPILE(expr_)
 
#define QHSM_INIT(me_, par_, qsId_)
 
#define QHSM_DISPATCH(me_, e_, qsId_)
 
#define QHsm_isIn(me_, state_)
 
#define QF_PUBLISH(e_, sender_)
 
#define QF_TICK_X(tickRate_, sender_)
 Invoke the system clock tick processing.
 
#define QF_TICK(sender_)
 Invoke the system clock tick processing.
 
#define QF_getQueueMin(prio_)
 

Typedefs

typedef char char_t
 

Detailed Description

QP/C interface including the backwards-compatibility layer.

Definition in file qpc.h.

Macro Definition Documentation

◆ QP_API_VERSION

#define QP_API_VERSION   0

Definition at line 41 of file qpc.h.

◆ QM_SUPER_SUB

#define QM_SUPER_SUB ( host_)
Value:
error "submachines no longer supported"

Definition at line 48 of file qpc.h.

◆ QM_TRAN_EP

#define QM_TRAN_EP ( tatbl_)
Value:
error "submachines no longer supported"

Definition at line 49 of file qpc.h.

◆ QM_TRAN_XP

#define QM_TRAN_XP ( xp_,
tatbl_ )
Value:
error "submachines no longer supported"

Definition at line 50 of file qpc.h.

◆ QACTIVE_START

#define QACTIVE_START ( me_,
prioSpec_,
qSto_,
qLen_,
stkSto_,
stkSize_,
par_ )
Value:
(QActive_start((QActive *)(me_), (prioSpec_), \
(qSto_), (qLen_), (stkSto_), (stkSize_), (par_)))
QActive
Active object class (based on the QHsm implementation strategy)
Definition qp.h:505
Deprecated
Macro for starting an Active Object. Use QActive::QActive_start() instead.

Definition at line 62 of file qpc.h.

◆ QXTHREAD_START

#define QXTHREAD_START ( me_,
prioSpec_,
qSto_,
qLen_,
stkSto_,
stkSize_,
par_ )
Value:
(QXThread_start((QXThread *)(me_), (prioSpec_), \
(qSto_), (qLen_), (stkSto_), (stkSize_), (par_)))
QXThread
eXtended (blocking) thread of the QXK preemptive kernel
Definition qxk.h:86
Deprecated
Macro for starting an eXtended Thread. Use QXThread::QXThread_start() instead.

Definition at line 68 of file qpc.h.

◆ Q_onAssert

#define Q_onAssert ( module_,
id_ )
Value:
Q_onError(module_, id_)
Q_onError
Q_NORETURN Q_onError(char const *const module, int_t const id)
Custom error handler Callback function invoked after detecting an error (part of QP Functional Safety...
Deprecated
Assertion failure handler. Use Q_onError() instead.

Definition at line 74 of file qpc.h.

◆ Q_ALLEGE_ID

#define Q_ALLEGE_ID ( id_,
expr_ )
Value:
if (!(expr_)) { \
QF_CRIT_STAT \
QF_CRIT_ENTRY(); \
Q_onError(&Q_this_module_[0], (id_)); \
QF_CRIT_EXIT(); \
} else ((void)0)
Deprecated
#Q_NASSERT preprocessor switch to disable QP assertions
Deprecated
general purpose assertion with user-specified ID number that always evaluates the expr_ expression.
Note
The use of this macro is no longer recommended.

Definition at line 98 of file qpc.h.

◆ Q_ALLEGE

#define Q_ALLEGE ( expr_)
Value:
Q_ALLEGE_ID(__LINE__, (expr_))
Q_ALLEGE_ID
#define Q_ALLEGE_ID(id_, expr_)
Definition qpc.h:98
Deprecated
general purpose assertion without ID number that always evaluates the expr_ expression. Instead of ID number, this macro is based on the standard __LINE__ macro.
Note
The use of this macro is no longer recommended.

Definition at line 113 of file qpc.h.

◆ Q_ASSERT_COMPILE

#define Q_ASSERT_COMPILE ( expr_)
Value:
Q_ASSERT_STATIC(expr_)
Q_ASSERT_STATIC
#define Q_ASSERT_STATIC(expr_)
Definition qsafe.h:114

Static (compile-time) assertion.

Deprecated
Use Q_ASSERT_STATIC() or better yet _Static_assert() instead.

Definition at line 118 of file qpc.h.

◆ QHSM_INIT

#define QHSM_INIT ( me_,
par_,
qsId_ )
Value:
QASM_INIT((me_), (par_), (qsId_))
QASM_INIT
#define QASM_INIT(me_, par_, qsId_)
QVirtual call to the top-most initial transition in a HSM.
Definition qp.h:234
Deprecated
instead use: QASM_INIT()

Definition at line 130 of file qpc.h.

◆ QHSM_DISPATCH

#define QHSM_DISPATCH ( me_,
e_,
qsId_ )
Value:
QASM_DISPATCH((me_), (e_), (qsId_))
QASM_DISPATCH
#define QASM_DISPATCH(me_, e_, qsId_)
Virtual call to dispatch an event to a HSM.
Definition qp.h:236
Deprecated
instead use: QASM_DISPATCH()

Definition at line 133 of file qpc.h.

◆ QHsm_isIn

#define QHsm_isIn ( me_,
state_ )
Value:
QASM_IS_IN((QAsm *)(me_), (state_))
QASM_IS_IN
#define QASM_IS_IN(me_, stateHndl_)
Virtual call to check whether a SM is in a given state.
Definition qp.h:238
QAsm
Abstract State Machine class (state machine interface)
Definition qp.h:179
Deprecated
instead use: QASM_IS_IN()

Definition at line 136 of file qpc.h.

◆ QF_PUBLISH

#define QF_PUBLISH ( e_,
sender_ )
Value:
QACTIVE_PUBLISH((e_), (sender_))
QACTIVE_PUBLISH
#define QACTIVE_PUBLISH(e_, sender_)
Publish an event to all subscriber Active Objects.
Definition qp.h:799

Definition at line 138 of file qpc.h.

◆ QF_TICK_X

#define QF_TICK_X ( tickRate_,
sender_ )
Value:
QTIMEEVT_TICK_X((tickRate_), (sender_))
QTIMEEVT_TICK_X
#define QTIMEEVT_TICK_X(tickRate_, sender_)
Invoke the system clock tick processing QTimeEvt_tick_()
Definition qp.h:801

Invoke the system clock tick processing.

Deprecated
superseded by QTIMEEVT_TICK_X()

Definition at line 139 of file qpc.h.

◆ QF_TICK

#define QF_TICK ( sender_)
Value:
QTIMEEVT_TICK(sender_)
QTIMEEVT_TICK
#define QTIMEEVT_TICK(sender_)
Invoke the system clock tick processing for tick rate 0.
Definition qp.h:814

Invoke the system clock tick processing.

Deprecated
superseded by QTIMEEVT_TICK()

Definition at line 140 of file qpc.h.

◆ QF_getQueueMin

#define QF_getQueueMin ( prio_)
Value:
(QActive_getQueueMin((prio_)))
Deprecated
instead use: QActive::QActive_getQueueMin()

Definition at line 143 of file qpc.h.

Typedef Documentation

◆ char_t

typedef char char_t
Deprecated
plain 'char' is no longer forbidden in MISRA-C:2023

Definition at line 58 of file qpc.h.