CORDET Framework - C2 Implementation
CrFwInCmd.h
Go to the documentation of this file.
1 
55 #ifndef CRFW_INCMD_H_
56 #define CRFW_INCMD_H_
57 
58 /* Include FW Profile files */
59 #include "FwSmConstants.h"
60 #include "FwPrConstants.h"
61 /* Include configuration files */
62 #include "Pckt/CrFwPcktQueue.h"
63 #include "CrFwUserConstants.h"
64 /* Include framework files */
65 #include "CrFwConstants.h"
66 
76 FwSmDesc_t CrFwInCmdMakeBase();
77 
82 void CrFwInCmdTerminate(FwSmDesc_t smDesc);
83 
90 CrFwBool_t CrFwInCmdIsInAccepted(FwSmDesc_t smDesc);
91 
98 CrFwBool_t CrFwInCmdIsInProgress(FwSmDesc_t smDesc);
99 
106 CrFwBool_t CrFwInCmdIsInTerminated(FwSmDesc_t smDesc);
107 
114 CrFwBool_t CrFwInCmdIsInAborted(FwSmDesc_t smDesc);
115 
125 void CrFwInCmdConfigCheck(FwPrDesc_t prDesc);
126 
142 
151 void CrFwInCmdSetProgressStepId(FwSmDesc_t smDesc, CrFwProgressStepId_t stepId);
152 
171 
178 void CrFwInCmdSetProgressActionCompleted(FwSmDesc_t smDesc, CrFwBool_t progressActionCompleted);
179 
195 
201 CrFwDestSrc_t CrFwInCmdGetSrc(FwSmDesc_t smDesc);
202 
208 CrFwGroup_t CrFwInCmdGetGroup(FwSmDesc_t smDesc);
209 
215 CrFwServType_t CrFwInCmdGetServType(FwSmDesc_t smDesc);
216 
222 CrFwServType_t CrFwInCmdGetServSubType(FwSmDesc_t smDesc);
223 
230 
237 CrFwBool_t CrFwInCmdIsAcceptAck(FwSmDesc_t smDesc);
238 
245 CrFwBool_t CrFwInCmdIsStartAck(FwSmDesc_t smDesc);
246 
253 CrFwBool_t CrFwInCmdIsProgressAck(FwSmDesc_t smDesc);
254 
261 CrFwBool_t CrFwInCmdIsTermAck(FwSmDesc_t smDesc);
262 
268 CrFwSeqCnt_t CrFwInCmdGetSeqCnt(FwSmDesc_t smDesc);
269 
280 CrFwPckt_t CrFwInCmdGetParStart(FwSmDesc_t smDesc);
281 
293 CrFwPckt_t CrFwInCmdGetPckt(FwSmDesc_t smDesc);
294 
305 CrFwPcktLength_t CrFwInCmdGetParLength(FwSmDesc_t smDesc);
306 
324 CrFwPckt_t CrFwInCmdGetPcktFromPrDesc(FwPrDesc_t prDesc);
325 
338 CrFwBool_t CrFwInCmdDefValidityCheck(FwPrDesc_t prDesc);
339 
340 #endif /* CRFW_INCMD_H_ */
Header file to define all invariant publicly available constants and types for the CORDET Framework.
unsigned char * CrFwPckt_t
Type for packets (see CrFwPckt.h).
Definition: CrFwConstants.h:38
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
CrFwBool_t CrFwInCmdIsStartAck(FwSmDesc_t smDesc)
Return the acknowledge level for command start for the command encapsulated in the InCommand.
Definition: CrFwInCmd.c:366
CrFwPckt_t CrFwInCmdGetPcktFromPrDesc(FwPrDesc_t prDesc)
Convenience function to extract the InCommand's packet from the descriptor of the InCommand's reset p...
Definition: CrFwInCmd.c:200
CrFwBool_t CrFwInCmdDefValidityCheck(FwPrDesc_t prDesc)
Default implementation of the validity check of an InCommand.
Definition: CrFwInCmd.c:436
CrFwBool_t CrFwInCmdIsInAccepted(FwSmDesc_t smDesc)
Return true if the argument InCommand is in state ACCEPTED.
Definition: CrFwInCmd.c:155
CrFwBool_t CrFwInCmdIsProgressAck(FwSmDesc_t smDesc)
Return the acknowledge level for command progress for the command encapsulated in the InCommand.
Definition: CrFwInCmd.c:373
CrFwDiscriminant_t CrFwInCmdGetDiscriminant(FwSmDesc_t smDesc)
Return the discriminant of the InCommand.
Definition: CrFwInCmd.c:352
CrFwPckt_t CrFwInCmdGetParStart(FwSmDesc_t smDesc)
Return the start address of the parameter area of the InCommand.
Definition: CrFwInCmd.c:394
CrFwProgressStepId_t CrFwInCmdGetNOfProgressFailure(FwSmDesc_t smDesc)
Return the number of progress step failures.
Definition: CrFwInCmd.c:429
void CrFwInCmdTerminate(FwSmDesc_t smDesc)
Send command Terminate to the argument InCommand.
Definition: CrFwInCmd.c:150
CrFwBool_t CrFwInCmdIsInProgress(FwSmDesc_t smDesc)
Return true if the argument InCommand is in state PROGRESS.
Definition: CrFwInCmd.c:160
CrFwServType_t CrFwInCmdGetServType(FwSmDesc_t smDesc)
Return the type of the InCommand.
Definition: CrFwInCmd.c:338
void CrFwInCmdConfigCheck(FwPrDesc_t prDesc)
Configuration check for an InCommand.
Definition: CrFwInCmd.c:175
CrFwDestSrc_t CrFwInCmdGetSrc(FwSmDesc_t smDesc)
Return the source of the InCommand.
Definition: CrFwInCmd.c:324
FwSmDesc_t CrFwInCmdMakeBase()
Return the base InCommand from which all other InCommands are derived.
Definition: CrFwInCmd.c:110
CrFwGroup_t CrFwInCmdGetGroup(FwSmDesc_t smDesc)
Return the group of the InCommand.
Definition: CrFwInCmd.c:331
CrFwBool_t CrFwInCmdIsInAborted(FwSmDesc_t smDesc)
Return true if the argument InCommand is in state ABORTED.
Definition: CrFwInCmd.c:170
CrFwBool_t CrFwInCmdIsProgressActionCompleted(FwSmDesc_t smDesc)
Return the Completion Outcome of the progress action.
Definition: CrFwInCmd.c:415
CrFwBool_t CrFwInCmdIsTermAck(FwSmDesc_t smDesc)
Return the acknowledge level for command termination for the command encapsulated in the InCommand.
Definition: CrFwInCmd.c:380
void CrFwInCmdSetProgressActionCompleted(FwSmDesc_t smDesc, CrFwBool_t progressActionCompleted)
Set the Completion Outcome of the progress action.
Definition: CrFwInCmd.c:422
CrFwPcktLength_t CrFwInCmdGetParLength(FwSmDesc_t smDesc)
Return the length in bytes of the parameter area of the InCommand.
Definition: CrFwInCmd.c:401
CrFwSeqCnt_t CrFwInCmdGetSeqCnt(FwSmDesc_t smDesc)
Return the sequence counter of the InCommand.
Definition: CrFwInCmd.c:387
CrFwPckt_t CrFwInCmdGetPckt(FwSmDesc_t smDesc)
Return the pointer to the packet which holds the InCommand.
Definition: CrFwInCmd.c:408
void CrFwInCmdSetProgressStepId(FwSmDesc_t smDesc, CrFwProgressStepId_t stepId)
Set the progress step identifier of the InCommand.
Definition: CrFwInCmd.c:193
CrFwProgressStepId_t CrFwInCmdGetProgressStepId(FwSmDesc_t smDesc)
Return the progress step identifier of the InCommand.
Definition: CrFwInCmd.c:186
CrFwBool_t CrFwInCmdIsAcceptAck(FwSmDesc_t smDesc)
Return the acknowledge level for command acceptance for the command encapsulated in the InCommand.
Definition: CrFwInCmd.c:359
CrFwBool_t CrFwInCmdIsInTerminated(FwSmDesc_t smDesc)
Return true if the argument InCommand is in state TERMINATED.
Definition: CrFwInCmd.c:165
CrFwServType_t CrFwInCmdGetServSubType(FwSmDesc_t smDesc)
Return the sub-type of the InCommand.
Definition: CrFwInCmd.c:345
Definition and management of packet queues.
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
unsigned short CrFwProgressStepId_t
Type for the Progress Step Identifier of an InCommand.
unsigned int CrFwSeqCnt_t
Type used for the sequence counter of commands or reports.
unsigned char CrFwServType_t
Type used for the service type of a command or report.
unsigned char CrFwDestSrc_t
Type used for the command or report destination and source.
unsigned short CrFwDiscriminant_t
Type used for the discriminant of a command or report.
unsigned short int CrFwPcktLength_t
Type for the packet length.
unsigned char CrFwGroup_t
Type used for the destination or source group of a packet.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved