QP::QTicker Class Reference

"Ticker" Active Object class More...

#include "qp.hpp"

Inheritance diagram for QP::QTicker:

Public Member Functions
	QTicker (std::uint_fast8_t const tickRate) noexcept
void	init (void const *const e, std::uint_fast8_t const qsId) override
	Virtual function to take the top-most initial transition in the state machine.
void	init (std::uint_fast8_t const qsId) override
	Virtual function to take the top-most initial transition in the state machine (overloaded).
void	dispatch (QEvt const *const e, std::uint_fast8_t const qsId) override
	Virtual function to dispatch an event to the state machine.
void	trig_ (void const *const sender) noexcept
Public Member Functions inherited from QP::QActive
bool	isIn (QStateHandler const state) noexcept override
	Virtual function to check whether the state machine is in a given state.
QStateHandler	childState (QStateHandler const parent) noexcept
void	setAttr (std::uint32_t attr1, void const *attr2=nullptr)
void	start (QPrioSpec const prioSpec, QEvtPtr *const qSto, std::uint_fast16_t const qLen, void *const stkSto, std::uint_fast16_t const stkSize, void const *const par)
void	start (QPrioSpec const prioSpec, QEvtPtr *const qSto, std::uint_fast16_t const qLen, void *const stkSto, std::uint_fast16_t const stkSize)
void	stop ()
void	register_ () noexcept
void	unregister_ () noexcept
bool	post_ (QEvt const *const e, std::uint_fast16_t const margin, void const *const sender) noexcept
void	postLIFO (QEvt const *const e) noexcept
QEvt const *	get_ () noexcept
void	subscribe (enum_t const sig) const noexcept
void	unsubscribe (enum_t const sig) const noexcept
void	unsubscribeAll () const noexcept
bool	defer (QEQueue *const eq, QEvt const *const e) const noexcept
bool	recall (QEQueue *const eq) noexcept
std::uint_fast16_t	flushDeferred (QEQueue *const eq, std::uint_fast16_t const num=0xFFFFU) const noexcept
std::uint_fast8_t	getPrio () const noexcept
void	setPrio (QPrioSpec const prio) noexcept
std::uint_fast8_t	getPThre () const noexcept
QACTIVE_EQUEUE_TYPE const &	getEQueue () const noexcept
QACTIVE_OS_OBJ_TYPE const &	getOsObject () const noexcept
QACTIVE_THREAD_TYPE const &	getThread () const noexcept
void	setThread (QACTIVE_THREAD_TYPE const &thr)
virtual bool	postFromISR (QEvt const *const e, std::uint_fast16_t const margin, void *par, void const *const sender) noexcept
Public Member Functions inherited from QP::QAsm
virtual	~QAsm () noexcept
	Virtual destructor of the QP::QAsm abstract base class.
QStateHandler	state () const noexcept
QMState const *	stateObj () const noexcept
virtual QStateHandler	getStateHandler () noexcept
	Virtual method for getting the state handler.

Additional Inherited Members
Public Types inherited from QP::QAsm
enum	QStateRet : QState {   Q_RET_SUPER , Q_RET_UNHANDLED , Q_RET_HANDLED , Q_RET_IGNORED ,   Q_RET_ENTRY , Q_RET_EXIT , Q_RET_NULL , Q_RET_TRAN ,   Q_RET_TRAN_INIT , Q_RET_TRAN_HIST }
enum	ReservedSig : QSignal { Q_EMPTY_SIG , Q_ENTRY_SIG , Q_EXIT_SIG , Q_INIT_SIG }
	Reserved signals by the QP-framework. More...
Static Public Member Functions inherited from QP::QActive
static std::uint_fast16_t	getQueueMin (std::uint_fast8_t const prio) noexcept
static void	psInit (QSubscrList *const subscrSto, enum_t const maxSignal) noexcept
static void	publish_ (QEvt const *const e, void const *const sender, std::uint_fast8_t const qsId) noexcept
static void	evtLoop_ (QActive *act)
static void	publishFromISR (QEvt const *e, void *par, void const *sender) noexcept
Static Public Member Functions inherited from QP::QAsm
static QState	top (void *const me, QEvt const *const e) noexcept
	Top state handler that ignores all events.
Public Attributes inherited from QP::QActive
std::uint8_t	m_prio_dis
std::uint8_t	m_pthre_dis
Static Public Attributes inherited from QP::QActive
static QActive *	registry_ [QF_MAX_ACTIVE+1U]
static QSubscrList *	subscrList_
static enum_t	maxPubSignal_
Protected Member Functions inherited from QP::QActive
	QActive (QStateHandler const initial) noexcept
Protected Member Functions inherited from QP::QAsm
	QAsm () noexcept
	Constructor of the QP::QAsm base class.
QState	tran (QStateHandler const target) noexcept
	Internal helper function to take a state transition in sublclasses of QP::QAsm.
QState	tran_hist (QStateHandler const hist) noexcept
	Internal helper function to take a state transition to history in sublclasses of QP::QAsm.
QState	super (QStateHandler const superstate) noexcept
	Internal helper function to indicate superstate of a given state in sublclasses of QP::QAsm.
QState	qm_tran (void const *const tatbl) noexcept
	Internal helper function to take a state transition in QP::QMsm.
QState	qm_tran_init (void const *const tatbl) noexcept
QState	qm_tran_hist (QMState const *const hist, void const *const tatbl) noexcept
	Internal helper function to take a state transition to history in QP::QMsm.
QState	qm_entry (QMState const *const s) noexcept
	Internal helper function to execute state entry actions in QP::QMsm.
QState	qm_exit (QMState const *const s) noexcept
	Internal helper function to execute state exit actions in QP::QMsm.
Protected Attributes inherited from QP::QActive
std::uint8_t	m_prio
std::uint8_t	m_pthre
QACTIVE_THREAD_TYPE	m_thread
QACTIVE_OS_OBJ_TYPE	m_osObject
QACTIVE_EQUEUE_TYPE	m_eQueue
Protected Attributes inherited from QP::QAsm
QAsmAttr	m_state
	Current state (pointer to the current state-handler function)
QAsmAttr	m_temp
	Temporary storage for target/act-table etc.

Detailed Description

"Ticker" Active Object class

Details

QTicker is an efficient active object specialized to process QF system clock tick at a specified tick rate [0..QF_MAX_TICK_RATE]. Placing system clock tick processing in an active object allows you to remove the non-deterministic QTIMEEVT_TICK_X() processing from the interrupt level and move it into the thread-level, where you can prioritize it as low as you wish.

Usage

The following example illustrates use of QTicker active objects:

Attention

The QTicker active objects must be started without any queue buffer and without any stack (see AO_TickerX->start() calls in the code below).

// bsp.hpp -----------------
extern QP::QActive * const AO_Ticker0; // "ticker" pointer for clock rate 0
extern QP::QActive * const AO Ticker1; // "ticker" pointer for clock rate 1
 
 
// bsp.cpp -----------------
static QP::QTicker l_ticker0(0); // "ticker" instance for clock rate 0
QP::QActive * const AO_Ticker0 = &l_ticker0;
 
static QTicker l_ticker1(1); // "ticker" instance for clock rate 1
QP::QActive * const AO_Ticker1 = &l_ticker1;
 
// clock tick ISR for tick rate 0
void SysTick_Handler(void) {
    . . .
    AO_Ticker0->TRIG(&qs_tick0_id);
    . . .
}
 
// clock tick ISR for tick rate 1
void Timer0A_IRQHandler(void) {
    . . .
    AO_Ticker1->TRIG(&qs_tick1_id);
    . . .
}
 
// main.cpp ---------------
main () {
    . . .
    AO_Ticker0->start(
        1U, // priority
        0, 0, 0, 0); // must be always 0 for ticker AO
 
    AO_Ticker1->start(
        2U, // priority
        0, 0, 0, 0); // must be always 0 for ticker AO
    . . .
}

Definition at line 1014 of file qp.hpp.

Constructor & Destructor Documentation

QTicker()

QP::QTicker::QTicker ( std::uint_fast8_t const tickRate )

explicitnoexcept

Constructor of the QTicker Active Object class

Definition at line 449 of file qf_actq.cpp.

Member Function Documentation

init() [1/2]

void QP::QTicker::init ( void const *const e, std::uint_fast8_t const qsId )

overridevirtual

Virtual function to take the top-most initial transition in the state machine.

Details

Synchronously executes the top-most initial transition in a state machine (must be overridden in the subclasses).

Parameters

[in]	e	pointer to an initialization parameter (might be nullptr)
[in]	qsId	QS-id of this state machine (for QS local filter)

Reimplemented from QP::QActive.

Definition at line 460 of file qf_actq.cpp.

init() [2/2]

void QP::QTicker::init ( std::uint_fast8_t const qsId )

inlineoverridevirtual

Virtual function to take the top-most initial transition in the state machine (overloaded).

Details

Synchronously executes the top-most initial transition in a state machine. This overloaded version takes no initialization parameter.

Parameters

[in]

qsId

QS-id of this state machine (for QS local filter)

Reimplemented from QP::QActive.

Definition at line 1020 of file qp.hpp.

dispatch()

void QP::QTicker::dispatch ( QEvt const *const e, std::uint_fast8_t const qsId )

overridevirtual

Virtual function to dispatch an event to the state machine.

Details

Synchronously dispatches an event for processing to a state machine (must be overridden in the subclasses). The processing of an event represents one run-to-completion (RTC) step.

Parameters

[in]	e	pointer to the event to be dispatched to the MSM
[in]	qsId	QS-id of this state machine (for QS local filter)

Reimplemented from QP::QActive.

Definition at line 481 of file qf_actq.cpp.

trig_()

void QP::QTicker::trig_ ( void const *const sender )

noexcept

Asynchronously trigger the QTicker active object to perform tick processing.

Details

This function only triggers the given "ticker" AO. The actual clock-tick processing happens in the thread context of the "ticker" AO, running at the configured priority level.

Definition at line 519 of file qf_actq.cpp.

---

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

• qp.hpp
• qf_actq.cpp
• qp.dox