19 #ifndef CRFW_UTILITY_FUNCTIONS_H_ 20 #define CRFW_UTILITY_FUNCTIONS_H_ 23 #include "FwSmConstants.h" 24 #include "FwPrConstants.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").
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...