Dummy Active Object class. More...

#include <qs.hpp>

Inheritance diagram for QActiveDummy:

Collaboration diagram for QActiveDummy:

Public Member Functions
	QActiveDummy (void)

void	start (std::uint_fast8_t const prio, QEvt const *const qSto, std::uint_fast16_t const qLen, void const stkSto, std::uint_fast16_t const stkSize, void const *const par) override
	Starts execution of an active object and registers the object with the framework. More...

void	start (std::uint_fast8_t const prio, QEvt const *const qSto, std::uint_fast16_t const qLen, void const stkSto, std::uint_fast16_t const stkSize) override
	Overloaded start function (no initialization event) More...

void	init (void const *const e, std::uint_fast8_t const qs_id) noexcept override
	executes the top-most initial transition in QP::QHsm More...

void	init (std::uint_fast8_t const qs_id) noexcept override
	overloaded init(qs_id) More...

void	dispatch (QEvt const *const e, std::uint_fast8_t const qs_id) noexcept override
	Dispatches an event to QHsm. More...

bool	post_ (QEvt const const e, std::uint_fast16_t const margin, void const const sender) noexcept override

void	postLIFO (QEvt const *const e) noexcept override
	Posts an event directly to the event queue of the active object using the Last-In-First-Out (LIFO) policy. More...

Public Member Functions inherited from QActive
void	stop (void)
	Stops execution of an active object and removes it from the framework's supervision. More...

void	unsubscribeAll (void) const noexcept
	Un-subscribes from the delivery of all signals to the active object. More...

void	subscribe (enum_t const sig) const noexcept
	Subscribes for delivery of signal `sig` to the active object. More...

void	unsubscribe (enum_t const sig) const noexcept
	Un-subscribes from the delivery of signal `sig` to the active object. More...

bool	defer (QEQueue const eq, QEvt const const e) const noexcept
	Defer an event to a given separate event queue. More...

bool	recall (QEQueue *const eq) noexcept
	Recall a deferred event from a given event queue. More...

std::uint_fast16_t	flushDeferred (QEQueue *const eq) const noexcept
	Flush the specified deferred queue 'eq'. More...

std::uint_fast8_t	getPrio (void) const noexcept
	Get the priority of the active object. More...

void	setPrio (std::uint_fast8_t const prio)
	Set the priority of the active object. More...

void	setAttr (std::uint32_t attr1, void const *attr2=nullptr)
	Generic setting of additional attributes (useful in QP ports) More...

QEvt const *	get_ (void) noexcept
	Get an event from the event queue of an active object. More...

Public Member Functions inherited from QHsm
virtual	~QHsm ()
	virtual destructor More...

bool	isIn (QStateHandler const s) noexcept
	Tests if a given state is part of the current active state configuration. More...

QStateHandler	state (void) const noexcept
	Obtain the current state (state handler function) More...

QStateHandler	childState (QStateHandler const parent) noexcept
	Obtain the current active child state of a given parent. More...

Additional Inherited Members
Static Public Member Functions inherited from QHsm
static QState	top (void const me, QEvt const const e) noexcept
	the top-state. More...

Data Fields inherited from QActive
std::uint8_t	m_prio
	QF priority (1..QF_MAX_ACTIVE) of this active object. More...

Static Public Attributes inherited from QHsm
static constexpr QState	Q_RET_SUPER {static_cast<QState>(0)}
	event passed to the superstate to handle More...

static constexpr QState	Q_RET_SUPER_SUB {static_cast<QState>(1)}
	event passed to submachine superstate More...

static constexpr QState	Q_RET_UNHANDLED {static_cast<QState>(2)}
	event unhandled due to a guard evaluating to 'false' More...

static constexpr QState	Q_RET_HANDLED {static_cast<QState>(3)}
	event handled (internal transition) More...

static constexpr QState	Q_RET_IGNORED {static_cast<QState>(4)}
	event silently ignored (bubbled up to top) More...

static constexpr QState	Q_RET_ENTRY {static_cast<QState>(5)}
	state entry action executed More...

static constexpr QState	Q_RET_EXIT {static_cast<QState>(6)}
	state exit action executed More...

static constexpr QState	Q_RET_NULL {static_cast<QState>(7)}
	return value without any effect More...

static constexpr QState	Q_RET_TRAN {static_cast<QState>(8)}
	regular transition taken More...

static constexpr QState	Q_RET_TRAN_INIT {static_cast<QState>(9)}
	initial transition taken More...

static constexpr QState	Q_RET_TRAN_EP {static_cast<QState>(10)}
	entry-point transition into a submachine More...

static constexpr QState	Q_RET_TRAN_HIST {static_cast<QState>(11)}
	transition to history of a given state More...

static constexpr QState	Q_RET_TRAN_XP {static_cast<QState>(12)}
	exit-point transition out of a submachine More...

Protected Types inherited from QHsm
enum	ReservedHsmSignals : QSignal { Q_ENTRY_SIG = 1 , Q_EXIT_SIG , Q_INIT_SIG }

Protected Member Functions inherited from QActive
	QActive (QStateHandler const initial) noexcept
	protected constructor (abstract class) More...

Protected Member Functions inherited from QHsm
	QHsm (QStateHandler const initial) noexcept
	Protected constructor of QHsm. More...

QState	tran (QStateHandler const target) noexcept
	Helper function to specify a state transition. More...

QState	tran_hist (QStateHandler const hist) noexcept
	Helper function to specify a transition to history. More...

QState	super (QStateHandler const superstate) noexcept
	Helper function to specify the superstate of a given state. More...

QState	qm_tran (void const *const tatbl) noexcept
	Helper function to specify a regular state transition in a QM state-handler. More...

QState	qm_tran_hist (QMState const const hist, void const const tatbl) noexcept
	Helper function to specifiy a transition to history in a QM state-handler. More...

QState	qm_tran_init (void const *const tatbl) noexcept
	Helper function to specify an initial state transition in a QM state-handler. More...

QState	qm_tran_ep (void const *const tatbl) noexcept
	Helper function to specify a transition to an entry point to a submachine state in a QM state-handler. More...

QState	qm_tran_xp (QActionHandler const xp, void const *const tatbl) noexcept
	Helper function to specify a transition to an exit point from a submachine state in a QM state-handler. More...

QState	qm_entry (QMState const *const s) noexcept
	Helper function to specify a state entry in a QM state-handler. More...

QState	qm_exit (QMState const *const s) noexcept
	Helper function to specify a state exit in a QM state-handler. More...

virtual QStateHandler	getStateHandler () noexcept
	Get the current state handler of the HSM. More...

QState	qm_sm_exit (QMState const *const s) noexcept
	Helper function to specify a submachine exit in a QM state-handler. More...

QState	qm_super_sub (QMState const *const s) noexcept
	Helper function to call in a QM state-handler when it passes the event to the host submachine state to handle an event. More...

Detailed Description

Dummy Active Object class.

Description: QActiveDummy is a test double for the role of collaborating active objects in QUTest unit testing.

Definition at line 620 of file qs.hpp.

Constructor & Destructor Documentation

◆ QActiveDummy()

QActiveDummy ( void )

Definition at line 119 of file qutest.cpp.

Member Function Documentation

◆ start() [1/2]

void start	(	std::uint_fast8_t const	prio,
		QEvt const **const	qSto,
		std::uint_fast16_t const	qLen,
		void *const	stkSto,
		std::uint_fast16_t const	stkSize,
		void const *const	par
	)

overridevirtual

Starts execution of an active object and registers the object with the framework.

Description: Starts execution of the AO and registers the AO with the framework.

Parameters

[in]	prio	priority at which to start the active object
[in]	qSto	pointer to the storage for the ring buffer of the event queue (used only with the built-in QP::QEQueue)
[in]	qLen	length of the event queue (in events)
[in]	stkSto	pointer to the stack storage (must be nullptr in QV)
[in]	stkSize	stack size [bytes]
[in]	par	pointer to an extra parameter (might be nullptr)

Usage: The following example shows starting an AO when a per-task stack is needed
static Philo l_philo[N]; // N Philosopher active objects

static QEvt const *l_philQueueSto[N][N]; // storage for Philo event queues

static int l_philoStk[N][256]; // stacks for the Philosopher active objects

main() {

. . .

for (n = 0U; n < N; ++n) {

uint32_t options = 0x1234U;

ie.philNum = n;

l_philo[n].start(

n*10U + 1U, // QP priority [1..QF_MAX_ACTIVE]

l_philoQueueSto[n], // queue storage

Q_DIM(l_philoQueueSto[n]), // queue depth [QEvt* pointers]

l_philoStk[n], // RTOS stack storage

sizeof(l_philoStk[n]), // RTOS stack size [bytes]

&options); // initialization parameter

}

. . .

}

uint32_t
unsigned long int uint32_t
exact-width 32-bit unsigned int
Definition: 16bit/stdint.h:31

Q_DIM
#define Q_DIM(array_)
Helper macro to calculate static dimension of a 1-dim array_.
Definition: qassert.h:337

Precondition

AO cannot be started from an ISR, the priority must be in range and the stack storage must not be provided, because the QK kernel does not need per-AO stacks.

the priority must be in range and the stack storage must not be provided, because the QV kernel does not need per-AO stacks.

AO cannot be started:

from an ISR;
the priority must be in range;
the stack storage must NOT be provided (because the QXK kernel does not need per-AO stacks).

Reimplemented from QActive.

Definition at line 123 of file qutest.cpp.

◆ start() [2/2]

void start	(	std::uint_fast8_t const	prio,
		QEvt const **const	qSto,
		std::uint_fast16_t const	qLen,
		void *const	stkSto,
		std::uint_fast16_t const	stkSize
	)

inlineoverridevirtual

Overloaded start function (no initialization event)

Reimplemented from QActive.

Definition at line 630 of file qs.hpp.

◆ init() [1/2]

void init	(	void const *const	e,
		std::uint_fast8_t const	qs_id
	)

overridevirtualnoexcept

executes the top-most initial transition in QP::QHsm

Description: Executes the top-most initial transition in a HSM.

Parameters

[in]	e	pointer to an extra parameter (might be NULL)
[in]	qs_id	QS-id of this state machine (for QS local filter)

Note: Must be called exactly once before the QP::QHsm::dispatch().

Precondition: ctor must have been executed and initial tran NOT taken

Reimplemented from QHsm.

Definition at line 143 of file qutest.cpp.

◆ init() [2/2]

void init ( std::uint_fast8_t const qs_id )

inlineoverridevirtualnoexcept

overloaded init(qs_id)

Reimplemented from QHsm.

Definition at line 639 of file qs.hpp.

◆ dispatch()

void dispatch	(	QEvt const *const	e,
		std::uint_fast8_t const	qs_id
	)

overridevirtualnoexcept

Dispatches an event to QHsm.

Description: Dispatches an event for processing to a hierarchical state machine (HSM). The processing of an event represents one run-to-completion (RTC) step.

Parameters

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

Note: This state machine must be initialized by calling QP::QHsm::init() exactly once before calling QP::QHsm::dispatch().

Precondition: the current state must be initialized and the state configuration must be stable

Reimplemented from QHsm.

Definition at line 157 of file qutest.cpp.

◆ post_()

bool post_	(	QEvt const *const	e,
		std::uint_fast16_t const	margin,
		void const *const	sender
	)

overridevirtualnoexcept

Description: Direct event posting is the simplest asynchronous communication method available in QF.

Parameters

[in,out]	e	pointer to the event to be posted
[in]	margin	number of required free slots in the queue after posting the event. The special value QP::QF_NO_MARGIN means that this function will assert if posting fails.
[in]	sender	pointer to a sender object (used in QS only)

Returns: 'true' (success) if the posting succeeded (with the provided margin) and 'false' (failure) when the posting fails.

Attention: Should be called only via the macro POST() or POST_X().

Note: The QP::QF_NO_MARGIN value of the margin argument is special and denotes situation when the post() operation is assumed to succeed (event delivery guarantee). An assertion fires, when the event cannot be delivered in this case.

Usage: extern QActive *AO_Table;

QP::QState Philo::hungry(Philo * const me, QP::QEvt const * const e) {

QP::QState status;

switch (e->sig) {

case Q_ENTRY_SIG: {

TableEvt *pe = Q_NEW(TableEvt, HUNGRY_SIG);

pe->philoNum = PHILO_ID(me);

AO_Table->POST(pe, me);

status = Q_HANDLED();

break;

}

. . .

default: {

status = Q_SUPER(&QHsm::top);

break;

}

}

return status;

}

QP::QHsm::QActive
friend class QActive
Definition: qep.hpp:470

QP::QHsm::Q_ENTRY_SIG
@ Q_ENTRY_SIG
signal for entry actions
Definition: qep.hpp:372

QP::QHsm::top
static QState top(void *const me, QEvt const *const e) noexcept
the top-state.
Definition: qep_hsm.cpp:224

QP::QState
std::uint_fast8_t QState
Type returned from state-handler functions.
Definition: qep.hpp:223

Q_HANDLED
#define Q_HANDLED()
Macro to specify that the event was handled.
Definition: qep.hpp:631

Q_NEW
#define Q_NEW(evtT_, sig_)
Allocate a dynamic event.
Definition: qf.hpp:715

Q_SUPER
#define Q_SUPER(state_)
Definition: qpcpp.hpp:152

QP::QEvt
QEvt base class.
Definition: qep.hpp:209

QP::QEvt::sig
QSignal sig
signal of the event instance
Definition: qep.hpp:210

See also: QActive::postLIFO()

Precondition: event pointer must be valid

Reimplemented from QActive.

Definition at line 172 of file qutest.cpp.

◆ postLIFO()

void postLIFO ( QEvt const *const e )

overridevirtualnoexcept

Posts an event directly to the event queue of the active object using the Last-In-First-Out (LIFO) policy.

Description: posts an event to the event queue of the active object using the Last-In-First-Out (LIFO) policy.

Note: The LIFO policy should be used only for self-posting and with caution, because it alters order of events in the queue.

Parameters

[in] e pointer to the event to post to the queue

See also: QActive::post_()

Reimplemented from QActive.

Definition at line 227 of file qutest.cpp.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QActiveDummy()

Member Function Documentation

◆ start() [1/2]

◆ start() [2/2]

◆ init() [1/2]

◆ init() [2/2]

◆ dispatch()

◆ post_()

◆ postLIFO()