Abstract State Machine class (state machine interface) More...

#include "qp.hpp"

Inheritance diagram for QP::QAsm:

Public Types
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...

Public Member Functions
virtual	~QAsm () noexcept
	Virtual destructor of the QP::QAsm abstract base class.

virtual void	init (void const *const e, std::uint_fast8_t const qsId)=0
	Virtual function to take the top-most initial transition in the state machine.

virtual void	init (std::uint_fast8_t const qsId)
	Virtual function to take the top-most initial transition in the state machine (overloaded).

virtual void	dispatch (QEvt const *const e, std::uint_fast8_t const qsId)=0
	Virtual function to dispatch an event to the state machine.

virtual bool	isIn (QStateHandler const state) noexcept
	Virtual function to check whether the state machine is in a given state.

QStateHandler	state () const noexcept

QMState const *	stateObj () const noexcept

virtual QStateHandler	getStateHandler () noexcept
	Virtual method for getting the state handler.

Static Public Member Functions
static QState	top (void const me, QEvt const const e) noexcept
	Top state handler that ignores all events.

Protected Member Functions
	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
QAsmAttr	m_state
	Current state (pointer to the current state-handler function)

QAsmAttr	m_temp
	Temporary storage for target/act-table etc.

Detailed Description

Abstract State Machine class (state machine interface)

Backward Traceability

SDS_QP_QAsm : QAsm Abstract state machine class.

Definition at line 212 of file qp.hpp.

Member Enumeration Documentation

◆ QStateRet

enum QP::QAsm::QStateRet : QState

All possible return values from state-handlers

Note: The order is important for algorithmic correctness.

Enumerator
Q_RET_SUPER	event passed to superstate to handle
Q_RET_UNHANDLED	event unhandled due to a guard
Q_RET_HANDLED	event handled (internal transition)
Q_RET_IGNORED	event silently ignored (bubbled up to top)
Q_RET_ENTRY	state entry action executed
Q_RET_EXIT	state exit action executed
Q_RET_NULL	return value without any effect
Q_RET_TRAN	regular transition
Q_RET_TRAN_INIT	initial transition in a state
Q_RET_TRAN_HIST	transition to history of a given state

Definition at line 222 of file qp.hpp.

◆ ReservedSig

enum QP::QAsm::ReservedSig : QSignal

Reserved signals by the QP-framework.

Enumerator
Q_EMPTY_SIG	signal to execute the default case
Q_ENTRY_SIG	signal for entry actions
Q_EXIT_SIG	signal for exit actions
Q_INIT_SIG	signal for nested initial transitions

Definition at line 247 of file qp.hpp.

Constructor & Destructor Documentation

◆ QAsm()

QP::QAsm::QAsm ( )

inlineexplicitprotectednoexcept

Constructor of the QP::QAsm base class.

Details: The constructor initializes the QAsm::vptr and clears the internal attributes. The constructor is "protected" because it is only intended to be invoked from the subclasses of the abstract base class QP QAsm.

Parameters

[in,out] me current instance pointer (see Object Orientation)

Definition at line 255 of file qp.hpp.

◆ ~QAsm()

virtual QP::QAsm::~QAsm ( )

inlinevirtualnoexcept

Virtual destructor of the QP::QAsm abstract base class.

Details

Note: This virtual destructor is not provided by default and is provided only when the macro Q_XTOR is defined. This is because a presence of virtual destructor(s) seems to pull in the delete operator from the C++ library. This, in turn, might be problematic for deeply embedded systems that work without the heap and any other libraries.

Definition at line 263 of file qp.hpp.

Member Function Documentation

◆ init() [1/2]

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

pure virtual

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)

Implemented in QP::QActive, QP::QHsm, QP::QMActive, QP::QMsm, and QP::QTicker.

◆ init() [2/2]

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

inlinevirtual

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 in QP::QActive, QP::QHsm, QP::QMActive, QP::QMsm, and QP::QTicker.

Definition at line 270 of file qp.hpp.

◆ dispatch()

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

pure virtual

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)

Implemented in QP::QActive, QP::QHsm, QP::QMActive, QP::QMsm, and QP::QTicker.

◆ isIn()

virtual bool QP::QAsm::isIn ( QP::QStateHandler const state )

inlinevirtualnoexcept

Virtual function to check whether the state machine is in a given state.

Details: Tests if a given state is part of the current active state configuration. Please note that in a hierarchical state machine, to "be in a state" means also to be in a superstate of of the state.

Parameters

[in] state pointer to the state-handler function to be checked

Returns: 'true' if the state machine "is in" the state and 'false' otherwise

Attention: This function must be called only on a state machine that is in the "stable state configuration". Among others, this means that the state machine cannot call it in the middle of its own transition.

Precondition qep_hsm:602

internal integrity check (Software Self-Monitoring (SSM))

Backward Traceability

SRS_QP_SM_25 : All State Machine Implementation Strategies provided by QP/C++ Framework might supply a method for checking if a state machine is in a given state

Reimplemented in QP::QActive, QP::QHsm, QP::QMActive, and QP::QMsm.

Definition at line 276 of file qp.hpp.

◆ state()

QStateHandler QP::QAsm::state ( ) const

inlinenoexcept

Definition at line 280 of file qp.hpp.

◆ stateObj()

QMState const * QP::QAsm::stateObj ( ) const

inlinenoexcept

Definition at line 283 of file qp.hpp.

◆ getStateHandler()

virtual QStateHandler QP::QAsm::getStateHandler ( )

inlinevirtualnoexcept

Virtual method for getting the state handler.

Reimplemented in QP::QHsm, QP::QMActive, and QP::QMsm.

Definition at line 288 of file qp.hpp.

◆ top()

static QState QP::QAsm::top	(	void *const	me,
		QEvt const *const	e )

inlinestaticnoexcept

Top state handler that ignores all events.

Definition at line 292 of file qp.hpp.

◆ tran()

QState QP::QAsm::tran ( QStateHandler const target )

inlineprotectednoexcept

Internal helper function to take a state transition in sublclasses of QP::QAsm.

Definition at line 302 of file qp.hpp.

◆ tran_hist()

QState QP::QAsm::tran_hist ( QStateHandler const hist )

inlineprotectednoexcept

Internal helper function to take a state transition to history in sublclasses of QP::QAsm.

Definition at line 306 of file qp.hpp.

◆ super()

QState QP::QAsm::super ( QStateHandler const superstate )

inlineprotectednoexcept

Internal helper function to indicate superstate of a given state in sublclasses of QP::QAsm.

Definition at line 310 of file qp.hpp.

◆ qm_tran()

QState QP::QAsm::qm_tran ( void const *const tatbl )

inlineprotectednoexcept

Internal helper function to take a state transition in QP::QMsm.

Definition at line 314 of file qp.hpp.

◆ qm_tran_init()

QState QP::QAsm::qm_tran_init ( void const *const tatbl )

inlineprotectednoexcept

Definition at line 318 of file qp.hpp.

◆ qm_tran_hist()

QState QP::QAsm::qm_tran_hist	(	QMState const *const	hist,
		void const *const	tatbl )

inlineprotectednoexcept

Internal helper function to take a state transition to history in QP::QMsm.

Definition at line 322 of file qp.hpp.

◆ qm_entry()

QState QP::QAsm::qm_entry ( QMState const *const s )

inlineprotectednoexcept

Internal helper function to execute state entry actions in QP::QMsm.

Definition at line 332 of file qp.hpp.

◆ qm_exit()

QState QP::QAsm::qm_exit ( QMState const *const s )

inlineprotectednoexcept

Internal helper function to execute state exit actions in QP::QMsm.

Definition at line 346 of file qp.hpp.

Member Data Documentation

◆ m_state

QAsmAttr QP::QAsm::m_state

protected

Current state (pointer to the current state-handler function)

Definition at line 214 of file qp.hpp.

◆ m_temp

QAsmAttr QP::QAsm::m_temp

protected

Temporary storage for target/act-table etc.

Details: The m_temp data member is used for passing information from the QP Application to the "event processor" of QP. The m_temp member is also used as the Duplicate Inverse Storage of the state attribute in between transitions (part of QP Functional Safety (FuSa) Subsystem).

Definition at line 215 of file qp.hpp.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ QStateRet

◆ ReservedSig

Constructor & Destructor Documentation

◆ QAsm()

◆ ~QAsm()

Member Function Documentation

◆ init() [1/2]

◆ init() [2/2]

◆ dispatch()

◆ isIn()

◆ state()

◆ stateObj()

◆ getStateHandler()

◆ top()

◆ tran()

◆ tran_hist()

◆ super()

◆ qm_tran()

◆ qm_tran_init()

◆ qm_tran_hist()

◆ qm_entry()

◆ qm_exit()

Member Data Documentation

◆ m_state

◆ m_temp