CORDET Framework - C2 Implementation
CrFwBaseCmp.h
Go to the documentation of this file.
1 
51 #ifndef CRFW_BASE_CMP_H_
52 #define CRFW_BASE_CMP_H_
53 
54 /* Include FW Profile Files */
55 #include "FwSmConstants.h"
56 #include "FwPrConstants.h"
57 /* Include Framework Files */
58 #include "CrFwConstants.h"
59 /* Include Configuration Files */
60 #include "CrFwUserConstants.h"
61 
73 FwSmDesc_t CrFwBaseCmpMake();
74 
82 void CrFwCmpInit(FwSmDesc_t smDesc);
83 
91 void CrFwCmpReset(FwSmDesc_t smDesc);
92 
100 void CrFwCmpShutdown(FwSmDesc_t smDesc);
101 
109 void CrFwCmpExecute(FwSmDesc_t smDesc);
110 
120 void CrFwBaseCmpDefShutdownAction(FwSmDesc_t smDesc);
121 
130 FwPrDesc_t CrFwCmpGetInitPr(FwSmDesc_t smDesc);
131 
140 FwPrDesc_t CrFwCmpGetResetPr(FwSmDesc_t smDesc);
141 
150 FwPrDesc_t CrFwCmpGetExecPr(FwSmDesc_t smDesc);
151 
161 CrFwInstanceId_t CrFwCmpGetInstanceId(FwSmDesc_t smDesc);
162 
170 CrFwTypeId_t CrFwCmpGetTypeId(FwSmDesc_t smDesc);
171 
180 CrFwBool_t CrFwCmpIsStarted(FwSmDesc_t smDesc);
181 
190 CrFwBool_t CrFwCmpIsInCreated(FwSmDesc_t smDesc);
191 
200 CrFwBool_t CrFwCmpIsInInitialized(FwSmDesc_t smDesc);
201 
210 CrFwBool_t CrFwCmpIsInConfigured(FwSmDesc_t smDesc);
211 
212 #endif /* CRFW_BASE_CMP_H_ */
CrFwInstanceId_t CrFwCmpGetInstanceId(FwSmDesc_t smDesc)
Return the instance identifier of the argument component.
Definition: CrFwBaseCmp.c:150
CrFwBool_t CrFwCmpIsStarted(FwSmDesc_t smDesc)
Return true if the state machine of the argument component has been started.
Definition: CrFwBaseCmp.c:162
FwPrDesc_t CrFwCmpGetResetPr(FwSmDesc_t smDesc)
Return the descriptor of the Reset Procedure of the argument component.
Definition: CrFwBaseCmp.c:138
FwPrDesc_t CrFwCmpGetExecPr(FwSmDesc_t smDesc)
Return the descriptor of the Execution Procedure of the argument component.
Definition: CrFwBaseCmp.c:144
void CrFwCmpInit(FwSmDesc_t smDesc)
Initialize a framework component.
Definition: CrFwBaseCmp.c:112
CrFwBool_t CrFwCmpIsInInitialized(FwSmDesc_t smDesc)
Return true if the argument component is in state INITIALIZED.
Definition: CrFwBaseCmp.c:172
void CrFwCmpShutdown(FwSmDesc_t smDesc)
Shutdown a framework component.
Definition: CrFwBaseCmp.c:122
void CrFwBaseCmpDefShutdownAction(FwSmDesc_t smDesc)
Function which performs the Shutdown Action for the Base State Machine.
Definition: CrFwBaseCmp.c:217
CrFwBool_t CrFwCmpIsInConfigured(FwSmDesc_t smDesc)
Return true if the argument component is in state CONFIGURED.
Definition: CrFwBaseCmp.c:177
void CrFwCmpReset(FwSmDesc_t smDesc)
Reset a framework component.
Definition: CrFwBaseCmp.c:117
CrFwBool_t CrFwCmpIsInCreated(FwSmDesc_t smDesc)
Return true if the argument component is in state CREATED.
Definition: CrFwBaseCmp.c:167
FwPrDesc_t CrFwCmpGetInitPr(FwSmDesc_t smDesc)
Return the descriptor of the Initialization Procedure of the argument component.
Definition: CrFwBaseCmp.c:132
void CrFwCmpExecute(FwSmDesc_t smDesc)
Execute a framework component.
Definition: CrFwBaseCmp.c:127
FwSmDesc_t CrFwBaseCmpMake()
Retrieve the singleton instance of the Base State Machine.
Definition: CrFwBaseCmp.c:77
CrFwTypeId_t CrFwCmpGetTypeId(FwSmDesc_t smDesc)
Return the type identifier of the argument component.
Definition: CrFwBaseCmp.c:156
Header file to define all invariant publicly available constants and types for the CORDET Framework.
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
unsigned short int CrFwTypeId_t
Type used for the identifier of a component type.
unsigned short CrFwInstanceId_t
Type used for instance identifiers.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved