FW Profile - C1 Implementation
FwSmCore.h
Go to the documentation of this file.
1 
40 #ifndef FWSM_CORE_H_
41 #define FWSM_CORE_H_
42 
43 #include "FwSmConstants.h"
44 
60 void FwSmStart(FwSmDesc_t smDesc);
61 
69 void FwSmStop(FwSmDesc_t smDesc);
70 
109 void FwSmMakeTrans(FwSmDesc_t smDesc, FwSmCounterU2_t transId);
110 
118 void FwSmExecute(FwSmDesc_t smDesc);
119 
127 
141 
150 
172 
179 
192 
203 
214 
215 #endif /* FWSM_CORE_H_ */
FwSmDesc_t FwSmGetEmbSmCur(FwSmDesc_t smDesc)
Return the state machine embedded in the current state.
Definition: FwSmCore.c:208
FwSmDesc_t FwSmGetEmbSm(FwSmDesc_t smDesc, FwSmCounterS1_t i)
Return the state machine embedded in the i-th state of the argument state machine.
Definition: FwSmCore.c:217
void FwSmStop(FwSmDesc_t smDesc)
Stop a state machine.
Definition: FwSmCore.c:69
FwSmBool_t FwSmIsStarted(FwSmDesc_t smDesc)
Check whether the state machine is started.
Definition: FwSmCore.c:240
FwSmErrCode_t
Error codes and function return codes for the state machine functions.
Definition: FwSmConstants.h:82
void FwSmExecute(FwSmDesc_t smDesc)
Convenience method to execute a state machine.
Definition: FwSmCore.c:142
FwSmCounterU3_t FwSmGetExecCnt(FwSmDesc_t smDesc)
Return the State Machine Execution Counter.
Definition: FwSmCore.c:253
void FwSmMakeTrans(FwSmDesc_t smDesc, FwSmCounterU2_t transId)
Trigger a transition in a state machine.
Definition: FwSmCore.c:92
void FwSmStart(FwSmDesc_t smDesc)
Start a state machine.
Definition: FwSmCore.c:52
Header file to define all constants and types for the state machine module of the FW Profile...
int FwSmBool_t
Type used for booleans (0 is "false" and 1 is "true").
Definition: FwSmConstants.h:49
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
FwSmErrCode_t FwSmGetErrCode(FwSmDesc_t smDesc)
Return the error code of the argument state machine.
Definition: FwSmCore.c:248
Structure representing a state machine descriptor.
Definition: FwSmPrivate.h:303
FwSmCounterS1_t FwSmGetCurState(FwSmDesc_t smDesc)
Return the identifier of the current state in a state machine (or zero if the state machine is stoppe...
Definition: FwSmCore.c:222
FwSmCounterS1_t FwSmGetCurStateEmb(FwSmDesc_t smDesc)
Return the identifier of the current state of the state machine embedded in the current state (the su...
Definition: FwSmCore.c:227
FwSmCounterU3_t FwSmGetStateExecCnt(FwSmDesc_t smDesc)
Return the State Execution Counter.
Definition: FwSmCore.c:258
signed char FwSmCounterS1_t
Type used for signed counters with a "short" range.
Definition: FwSmConstants.h:79
P&P Software GmbH, Copyright 2011, All Rights Reserved