CORDET Framework - C2 Implementation
CrFwUtilityFunctions.h
Go to the documentation of this file.
1 
19 #ifndef CRFW_UTILITY_FUNCTIONS_H_
20 #define CRFW_UTILITY_FUNCTIONS_H_
21 
22 /* Include FW Profile Files */
23 #include "FwSmConstants.h"
24 #include "FwPrConstants.h"
25 /* Include Framework Files */
26 #include "CrFwConstants.h"
27 /* Include Configuration Files */
28 #include "CrFwUserConstants.h"
29 
47 
53 
66 void CrFwSetPrOutcome(FwPrDesc_t prDesc, CrFwOutcome_t outcome);
67 
77 FwPrBool_t CrFwIsPrOutcomeOne(FwPrDesc_t prDesc);
78 
93 void CrFwSetSmOutcome(FwSmDesc_t smDesc, CrFwOutcome_t outcome);
94 
109 CrFwOutcome_t CrFwGetSmOutcome(FwSmDesc_t smDesc);
110 
120 FwSmBool_t CrFwIsSmOutcomeZero(FwSmDesc_t smDesc);
121 
122 
132 FwSmBool_t CrFwIsSmOutcomeOne(FwSmDesc_t smDesc);
133 
143 FwSmBool_t CrFwIsSmOutcomeTwo(FwSmDesc_t smDesc);
144 
156 FwPrBool_t CrFwWaitOnePrCycle(FwPrDesc_t prDesc);
157 
164 CrFwBool_t CrFwPrCheckAlwaysTrue(FwPrDesc_t prDesc);
165 
172 CrFwBool_t CrFwSmCheckAlwaysTrue(FwSmDesc_t smDesc);
173 
180 CrFwBool_t CrFwSmCheckAlwaysFalse(FwSmDesc_t smDesc);
181 
187 void CrFwPrEmptyAction(FwPrDesc_t prDesc);
188 
194 void CrFwSmEmptyAction(FwSmDesc_t smDesc);
195 
201 void CrFwSmSuccessAction(FwSmDesc_t smDesc);
202 
219  CrFwCmdRepKindIndex_t length, CrFwCmdRepKindKey_t targetKey);
220 
221 #endif /* CRFW_BASE_CMP_H_ */
FwPrBool_t CrFwWaitOnePrCycle(FwPrDesc_t prDesc)
Convenience function which returns true when a procedure has spent more than one cycle in the current...
CrFwAppErrCode_t CrFwGetAppErrCode()
Return the value of the application error code.
void CrFwSmEmptyAction(FwSmDesc_t smDesc)
Convenience function to be used in a state machine as default implementation for an action which retu...
void CrFwSetAppErrCode(CrFwAppErrCode_t errCode)
Set the value of the application error code (see CrFwGetAppErrCode).
CrFwBool_t CrFwPrCheckAlwaysTrue(FwPrDesc_t prDesc)
Convenience function to be used in a procedure as default implementation for a check which always ret...
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
unsigned char CrFwOutcome_t
Type used for the outcome of a check (see CrFwCmpData).
CrFwAppErrCode_t
Application error code for the framework components.
Header file to define all invariant publicly available constants and types for the CORDET Framework...
FwSmBool_t CrFwIsSmOutcomeZero(FwSmDesc_t smDesc)
Convenience function to check whether the outcome of the last check or action is equal to 0 ("false")...
void CrFwPrEmptyAction(FwPrDesc_t prDesc)
Convenience function to be used in a procedure as default implementation for an action which returns ...
unsigned int CrFwCmdRepKindKey_t
Type for the component kind key in CrFwInFactory.c and CrFwOutFactory.c.
CrFwCmdRepKindIndex_t CrFwFindCmdRepKindIndex(CrFwCmdRepKindKey_t *cmdRepKindArray, CrFwCmdRepKindIndex_t length, CrFwCmdRepKindKey_t targetKey)
Convenience function to retrieve the index of an array where a certain target value is located...
CrFwOutcome_t CrFwGetSmOutcome(FwSmDesc_t smDesc)
Convenience function to get the outcome of the last check or action of a state machine.
unsigned short CrFwCmdRepKindIndex_t
Type for the index of a command or report kind.
void CrFwSetSmOutcome(FwSmDesc_t smDesc, CrFwOutcome_t outcome)
Convenience function to set the outcome of the last check or action of a state machine.
CrFwBool_t CrFwSmCheckAlwaysTrue(FwSmDesc_t smDesc)
Convenience function to be used in a state machine as default implementation for a check which always...
void CrFwSetPrOutcome(FwPrDesc_t prDesc, CrFwOutcome_t outcome)
Convenience function to set the outcome field of the component data of a procedure.
FwSmBool_t CrFwIsSmOutcomeTwo(FwSmDesc_t smDesc)
Convenience function to check whether the outcome of the last check or action is equal to 2...
void CrFwSmSuccessAction(FwSmDesc_t smDesc)
Convenience function to be used in a state machine as default implementation for an action which sets...
FwPrBool_t CrFwIsPrOutcomeOne(FwPrDesc_t prDesc)
Convenience function to check whether the outcome of the last check or action is equal to 1 ("true" o...
FwSmBool_t CrFwIsSmOutcomeOne(FwSmDesc_t smDesc)
Convenience function to check whether the outcome of the last check or action is equal to 1 ("true")...
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
CrFwBool_t CrFwSmCheckAlwaysFalse(FwSmDesc_t smDesc)
Convenience function to be used in a state machine as default implementation for a check which always...
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved