FW Profile - C1 Implementation
|
Declaration of the internal data structures of the FW State Machine Module. More...
Go to the source code of this file.
Data Structures | |
struct | SmPState_t |
Structure representing a proper state in state machine. More... | |
struct | SmCState_t |
Structure representing a choice pseudo state in a state machine. More... | |
struct | SmTrans_t |
Structure representing a transition. More... | |
struct | SmBaseDesc_t |
Structure representing the base descriptor of a state machine. More... | |
struct | FwSmDesc |
Structure representing a state machine descriptor. More... | |
Enumerations |
Functions | |
void | SmDummyAction (FwSmDesc_t smDesc) |
Dummy action which returns without doing anything. More... | |
FwSmBool_t | SmDummyGuard (FwSmDesc_t smDesc) |
Dummy guard which always returns true. More... | |
Declaration of the internal data structures of the FW State Machine Module.
Users should not normally be concerned with these data structures.
The data structures declared in this header file are used to define the state machine descriptor. A state machine descriptor holds all the information related to a certain state machine. A state machine descriptor consists of two parts: the base descriptor and the extension descriptor.
The base descriptor holds the information which is not changed when the state machine is extended. This consists of:
The extension descriptor holds the information which may be overridden when the state machine is extended. This consists of:
This file is part of the FW Profile.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
For information on alternative licensing, please contact P&P Software GmbH.
Definition in file FwSmPrivate.h.
enum StateType_t |
Enumerated type for the type of a state in a state machine.
Enumerator | |
---|---|
properState |
A proper state in a state machine. |
choicePseudoState |
A choice pseudo-state in a state machine. |
stoppedState |
Either the initial or the final pseudo-state. |
Definition at line 57 of file FwSmPrivate.h.
void SmDummyAction | ( | FwSmDesc_t | smDesc | ) |
Dummy action which returns without doing anything.
This action is used where nothing is specified for a state machine action (i.e. a state entry action, or a state do-action, or a state exit action, or a transition action).
smDesc | state machine descriptor. This parameter is unused in this dummy action. The parameter is retained for compatibility with the FwSmAction_t type. |
Definition at line 40 of file FwSmCore.c.
FwSmBool_t SmDummyGuard | ( | FwSmDesc_t | smDesc | ) |
Dummy guard which always returns true.
This guard is used where no transition guard is specified.
smDesc | state machine descriptor. This parameter is unused in this dummy guard. The parameter is retained for compatibility with the FwSmGuard_t type. |
Definition at line 46 of file FwSmCore.c.