FW Profile - C1 Implementation
FwSmPrivate.h
Go to the documentation of this file.
1 
49 #ifndef FWSM_PRIVATE_H_
50 #define FWSM_PRIVATE_H_
51 
52 #include "FwSmConstants.h"
53 
57 typedef enum {
70 } StateType_t;
71 
80 void SmDummyAction(FwSmDesc_t smDesc);
81 
90 
121 typedef struct {
132 } SmPState_t;
133 
149 typedef struct {
154 } SmCState_t;
155 
195 typedef struct {
204 } SmTrans_t;
205 
235 typedef struct {
248 } SmBaseDesc_t;
249 
303 struct FwSmDesc {
311  struct FwSmDesc** esmDesc;
327  void* smData;
328 };
329 
330 #endif /* FWSM_PRIVATE_H_ */
FwSmCounterS1_t curState
the current state of the state machine
Definition: FwSmPrivate.h:319
FwSmCounterS1_t outTransIndex
index of first out-going transition in transition array of SmBaseDesc_t
Definition: FwSmPrivate.h:151
FwSmCounterS1_t dest
the index of the destination of the transition
Definition: FwSmPrivate.h:197
FwSmCounterS1_t nOfOutTrans
number of outgoing transitions from the choice pseudo-state
Definition: FwSmPrivate.h:153
FwSmCounterS1_t iTrGuard
the index of the guard associated to the transition
Definition: FwSmPrivate.h:203
FwSmErrCode_t
Error codes and function return codes for the state machine functions.
Definition: FwSmConstants.h:82
FwSmCounterS1_t nOfActions
the number of actions (state actions + transition actions) in the state machine
Definition: FwSmPrivate.h:313
FwSmAction_t * smActions
the state machine actions (state and transition actions)
Definition: FwSmPrivate.h:307
FwSmCounterS1_t iDoAction
the do action for the state
Definition: FwSmPrivate.h:129
FwSmCounterS1_t nOfPStates
the number of states in the state machine
Definition: FwSmPrivate.h:243
SmCState_t * cStates
array holding the choice pseudo-states in the state machine
Definition: FwSmPrivate.h:239
A proper state in a state machine.
Definition: FwSmPrivate.h:61
FwSmCounterU2_t id
the identifier (the "name") of the transition
Definition: FwSmPrivate.h:199
FwSmErrCode_t errCode
either 'success' or the code of the last error encountered by the state machine
Definition: FwSmPrivate.h:325
FwSmCounterS1_t outTransIndex
index of first out-going transition in the transition array of SmBaseDesc_t
Definition: FwSmPrivate.h:123
Header file to define all constants and types for the state machine module of the FW Profile...
FwSmCounterS1_t transCnt
the counter for the number of transitions added to the state machine
Definition: FwSmPrivate.h:317
struct FwSmDesc ** esmDesc
the state machines embedded in the state machine
Definition: FwSmPrivate.h:311
FwSmBool_t(* FwSmGuard_t)(FwSmDesc_t)
Type for a pointer to a state machine guard.
Definition: FwSmConstants.h:64
int FwSmBool_t
Type used for booleans (0 is "false" and 1 is "true").
Definition: FwSmConstants.h:49
Either the initial or the final pseudo-state.
Definition: FwSmPrivate.h:69
FwSmCounterS1_t nOfCStates
the number of choice pseudo-states in the state machine
Definition: FwSmPrivate.h:245
FwSmCounterU3_t smExecCnt
the state machine execution counter
Definition: FwSmPrivate.h:321
FwSmCounterS1_t nOfOutTrans
number of outgoing transitions
Definition: FwSmPrivate.h:125
unsigned short int FwSmCounterU2_t
Type used for unsigned counters with a "medium" range.
Definition: FwSmConstants.h:70
unsigned int FwSmCounterU3_t
Type used for unsigned counters with a "long" range.
Definition: FwSmConstants.h:73
void * smData
the pointer to the data manipulated by the state machine actions and guards
Definition: FwSmPrivate.h:327
void(* FwSmAction_t)(FwSmDesc_t)
Type for a pointer to a state machine action.
Definition: FwSmConstants.h:46
FwSmCounterS1_t nOfTrans
the number of transitions in SM
Definition: FwSmPrivate.h:247
Structure representing a transition.
Definition: FwSmPrivate.h:195
Structure representing a state machine descriptor.
Definition: FwSmPrivate.h:303
FwSmCounterU3_t stateExecCnt
the state execution counter
Definition: FwSmPrivate.h:323
FwSmBool_t SmDummyGuard(FwSmDesc_t smDesc)
Dummy guard which always returns true.
Definition: FwSmCore.c:46
FwSmCounterS1_t iExitAction
the exit action for the state
Definition: FwSmPrivate.h:131
FwSmCounterS1_t iTrAction
the index of the action associated to the transition
Definition: FwSmPrivate.h:201
Structure representing the base descriptor of a state machine.
Definition: FwSmPrivate.h:235
FwSmCounterS1_t nOfGuards
the number of guards in the state machine
Definition: FwSmPrivate.h:315
A choice pseudo-state in a state machine.
Definition: FwSmPrivate.h:65
FwSmGuard_t * smGuards
the transition guards in the state machine
Definition: FwSmPrivate.h:309
void SmDummyAction(FwSmDesc_t smDesc)
Dummy action which returns without doing anything.
Definition: FwSmCore.c:40
SmPState_t * pStates
array holding the proper states in the state machine
Definition: FwSmPrivate.h:237
SmBaseDesc_t * smBase
pointer to the base descriptor
Definition: FwSmPrivate.h:305
Structure representing a choice pseudo state in a state machine.
Definition: FwSmPrivate.h:149
Structure representing a proper state in state machine.
Definition: FwSmPrivate.h:121
signed char FwSmCounterS1_t
Type used for signed counters with a "short" range.
Definition: FwSmConstants.h:79
FwSmCounterS1_t iEntryAction
the entry action for the state
Definition: FwSmPrivate.h:127
SmTrans_t * trans
array holding the transitions in the state machine
Definition: FwSmPrivate.h:241
StateType_t
Enumerated type for the type of a state in a state machine.
Definition: FwSmPrivate.h:57
P&P Software GmbH, Copyright 2011, All Rights Reserved