QP::QTicker Class Reference

"Ticker" Active Object class More...

#include <qp.hpp>

Inheritance diagram for QP::QTicker:

Public Member Functions
	QTicker (std::uint8_t const tickRate) noexcept
	Constructor of the QTicker Active Object class.
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	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
	Asynchronously trigger the QTicker active object to perform tick processing.
virtual void	init (std::uint_fast8_t const qsId)
	Virtual function to take the top-most initial transition in the state machine (overloaded).
Public Member Functions inherited from QP::QActive
bool	isIn (QStateHandler const stateHndl) noexcept override
	Virtual function to check whether the state machine is in a given state.
QStateHandler	getStateHandler () const noexcept override
	Virtual method for getting the current state handler.
QStateHandler	childState (QStateHandler const parentHandler) noexcept
void	setAttr (std::uint32_t attr1, void const *attr2=nullptr)
	Generic setting of additional attributes (defined in some QP ports).
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=nullptr)
	Starts execution of an active object and registers the object with the framework.
void	stop ()
	Stops execution of an active object and removes it from the framework's supervision.
void	register_ () noexcept
	Register this active object to be managed by the framework.
void	unregister_ () noexcept
	Un-register the active object from the framework.
void	post_ (QEvt const *const e, void const *const sender) noexcept
	Posts an event e directly to the event queue of the active object using the First-In-First-Out (FIFO) policy.
bool	postx_ (QEvt const *const e, std::uint_fast16_t const margin, void const *const sender) noexcept
	Posts an event e directly to the event queue of the active object using the First-In-First-Out (FIFO) policy.
void	postLIFO (QEvt const *const e) noexcept
	Posts an event e directly to the event queue of the active object using the Last-In-First-Out (LIFO) policy.
QEvt const *	get_ () noexcept
	Get an event from the event queue of an active object.
void	subscribe (QSignal const sig) const noexcept
	Subscribes for delivery of signal sig to the active object.
void	unsubscribe (QSignal const sig) const noexcept
	Unsubscribes from the delivery of signal sig to the active object.
void	unsubscribeAll () const noexcept
	Unsubscribes from the delivery of all signals to the active object.
bool	defer (QEQueue *const eq, QEvt const *const e) const noexcept
	Defer an event to a given separate event queue.
bool	recall (QEQueue *const eq) noexcept
	Recall a deferred event from a given event queue.
std::uint16_t	flushDeferred (QEQueue *const eq, std::uint_fast16_t const num=0xFFFFU) const noexcept
	Flush the specified deferred queue eq.
std::uint8_t	getPrio () const noexcept
QACTIVE_THREAD_TYPE const &	getThread () const &
QACTIVE_THREAD_TYPE const &	getThread () const &&=delete
void	setThread (QACTIVE_THREAD_TYPE const &thr) noexcept
QACTIVE_OS_OBJ_TYPE const &	getOsObject () const &
QACTIVE_OS_OBJ_TYPE const &	getOsObject () const &&=delete
virtual bool	postFromISR (QEvt const *const e, std::uint_fast16_t const margin, void *par, void const *const sender) noexcept
	The "FromISR" variant used in the QP port to "FreeRTOS".
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

Additional Inherited Members
Static Public Member Functions inherited from QP::QActive
static std::uint16_t	getQueueUse (std::uint_fast8_t const prio) noexcept
static std::uint16_t	getQueueFree (std::uint_fast8_t const prio) noexcept
static std::uint16_t	getQueueMin (std::uint_fast8_t const prio) noexcept
static void	psInit (QSubscrList *const subscrSto, QSignal const maxSignal) noexcept
	Publish event to all subscribers of a given signal e->sig.
static void	publish_ (QEvt const *const e, void const *const sender, std::uint_fast8_t const qsId) noexcept
	Publish event to all subscribers of a given signal e->sig.
static void	evtLoop_ (QActive *act)
	Event loop thread routine for executing an active object act (defined some in QP ports).
static QActive *	fromRegistry (std::uint_fast8_t const prio)
static void	publishFromISR (QEvt const *e, void *par, void const *sender) noexcept
	The "FromISR" variant used in the QP port to "FreeRTOS".
Static Public Member Functions inherited from QP::QAsm
static constexpr QState	Q_HANDLED ()
static constexpr QState	Q_UNHANDLED ()
static constexpr QState	QM_HANDLED ()
static constexpr QState	QM_UNHANDLED ()
static constexpr QState	QM_SUPER ()
static QState	top (void *const me, QEvt const *const e) noexcept
	Top state handler that ignores all events.
Public 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.
Static Public Attributes inherited from QP::QAsm
static constexpr QState	Q_RET_SUPER {0U}
static constexpr QState	Q_RET_UNHANDLED {1U}
static constexpr QState	Q_RET_HANDLED {2U}
static constexpr QState	Q_RET_TRAN {3U}
static constexpr QState	Q_RET_TRAN_HIST {4U}
static constexpr QState	Q_RET_IGNORED {5U}
static constexpr QState	Q_RET_ENTRY {6U}
static constexpr QState	Q_RET_EXIT {7U}
static constexpr QState	Q_RET_TRAN_INIT {8U}
static constexpr QSignal	Q_EMPTY_SIG {0U}
static constexpr QSignal	Q_ENTRY_SIG {1U}
static constexpr QSignal	Q_EXIT_SIG {2U}
static constexpr QSignal	Q_INIT_SIG {3U}
static constexpr QMState const *	QM_STATE_NULL { nullptr }
static constexpr QActionHandler const	Q_ACTION_NULL { nullptr }
Protected Member Functions inherited from QP::QActive
	QActive (QStateHandler const initial) noexcept
	QActive constructor (abstract base class).
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.

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 740 of file qp.hpp.

Constructor & Destructor Documentation

QTicker()

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

explicitnoexcept

Constructor of the QTicker Active Object class.

Definition at line 385 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 393 of file qf_actq.cpp.

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 412 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 441 of file qf_actq.cpp.

init() [2/2]

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

virtual

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 513 of file qf_act.cpp.

---

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

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