CORDET Framework - C2 Implementation
CrFwOutCmp.h
Go to the documentation of this file.
1 
61 #ifndef CRFW_OUTCMP_H_
62 #define CRFW_OUTCMP_H_
63 
64 /* Include FW Profile files */
65 #include "FwSmConstants.h"
66 #include "FwPrConstants.h"
67 /* Include configuration files */
68 #include "Pckt/CrFwPcktQueue.h"
69 #include "CrFwUserConstants.h"
70 /* Include framework files */
72 #include "CrFwConstants.h"
73 
83 FwSmDesc_t CrFwOutCmpMakeBase();
84 
89 void CrFwOutCmpTerminate(FwSmDesc_t smDesc);
90 
97 CrFwBool_t CrFwOutCmpIsInLoaded(FwSmDesc_t smDesc);
98 
105 CrFwBool_t CrFwOutCmpIsInAborted(FwSmDesc_t smDesc);
106 
113 CrFwBool_t CrFwOutCmpIsInPending(FwSmDesc_t smDesc);
114 
121 CrFwBool_t CrFwOutCmpIsInTerminated(FwSmDesc_t smDesc);
122 
134 CrFwBool_t CrFwOutCmpDefEnableCheck(FwSmDesc_t smDesc);
135 
148 void CrFwOutCmpDefSerialize(FwSmDesc_t smDesc);
149 
155 CrFwDestSrc_t CrFwOutCmpGetDest(FwSmDesc_t smDesc);
156 
162 void CrFwOutCmpSetDest(FwSmDesc_t smDesc, CrFwDestSrc_t dest);
163 
172 CrFwGroup_t CrFwOutCmpGetGroup(FwSmDesc_t smDesc);
173 
183 void CrFwOutCmpSetGroup(FwSmDesc_t smDesc, CrFwGroup_t group);
184 
193 CrFwTimeStamp_t CrFwOutCmpGetTimeStamp(FwSmDesc_t smDesc);
194 
203 void CrFwOutCmpSetTimeStamp(FwSmDesc_t smDesc, CrFwTimeStamp_t timeStamp);
204 
213 CrFwDestSrc_t CrFwOutCmpGetSrc(FwSmDesc_t smDesc);
214 
223 CrFwServType_t CrFwOutCmpGetServType(FwSmDesc_t smDesc);
224 
233 CrFwServType_t CrFwOutCmpGetServSubType(FwSmDesc_t smDesc);
234 
245 
254 void CrFwOutCmpSetDiscriminant(FwSmDesc_t smDesc, CrFwDiscriminant_t discriminant);
255 
267 void CrFwOutCmpSetAckLevel(FwSmDesc_t smDesc, CrFwBool_t accept, CrFwBool_t start,
268  CrFwBool_t progress, CrFwBool_t term);
269 
277 CrFwBool_t CrFwOutCmpIsAcceptAck(FwSmDesc_t smDesc);
278 
286 CrFwBool_t CrFwOutCmpIsStartAck(FwSmDesc_t smDesc);
287 
295 CrFwBool_t CrFwOutCmpIsProgressAck(FwSmDesc_t smDesc);
296 
304 CrFwBool_t CrFwOutCmpIsTermAck(FwSmDesc_t smDesc);
305 
316 CrFwPckt_t CrFwOutCmpGetParStart(FwSmDesc_t smDesc);
317 
328 CrFwPcktLength_t CrFwOutCmpGetParLength(FwSmDesc_t smDesc);
329 
337 CrFwPcktLength_t CrFwOutCmpGetLength(FwSmDesc_t smDesc);
338 
350 CrFwPckt_t CrFwOutCmpGetPckt(FwSmDesc_t smDesc);
351 
352 #endif /* CRFW_OUTCMP_H_ */
CrFwPcktLength_t CrFwOutCmpGetLength(FwSmDesc_t smDesc)
Return the length in bytes of the packet to which the OutComponent is serialized. ...
Definition: CrFwOutCmp.c:395
void CrFwOutCmpSetAckLevel(FwSmDesc_t smDesc, CrFwBool_t accept, CrFwBool_t start, CrFwBool_t progress, CrFwBool_t term)
Set the acknowledge level for the command encapsulated in the OutComponent.
Definition: CrFwOutCmp.c:265
CrFwBool_t CrFwOutCmpIsInTerminated(FwSmDesc_t smDesc)
Return true if the argument OutComponent is in state TERMINATED.
Definition: CrFwOutCmp.c:163
void CrFwOutCmpDefSerialize(FwSmDesc_t smDesc)
Default implementation of the Serialize Operation for an OutComponent.
Definition: CrFwOutCmp.c:173
CrFwBool_t CrFwOutCmpIsTermAck(FwSmDesc_t smDesc)
Return the acknowledge level for command termination for the command encapsulated in the OutComponent...
Definition: CrFwOutCmp.c:295
unsigned char * CrFwPckt_t
Type for packets (see CrFwPckt.h).
Definition: CrFwConstants.h:38
CrFwServType_t CrFwOutCmpGetServType(FwSmDesc_t smDesc)
Return the type of the OutComponent.
Definition: CrFwOutCmp.c:230
CrFwBool_t CrFwOutCmpDefEnableCheck(FwSmDesc_t smDesc)
Default implementation of the Enable Check Operation for an OutComponent.
Definition: CrFwOutCmp.c:168
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
void CrFwOutCmpSetGroup(FwSmDesc_t smDesc, CrFwGroup_t group)
Set the group of the OutComponent.
Definition: CrFwOutCmp.c:207
unsigned char CrFwGroup_t
Type used for the destination or source group of a packet.
CrFwBool_t CrFwOutCmpIsStartAck(FwSmDesc_t smDesc)
Return the acknowledge level for command start for the command encapsulated in the OutComponent...
Definition: CrFwOutCmp.c:281
Definition of the OutRegistry Component.
Header file to define all invariant publicly available constants and types for the CORDET Framework...
unsigned short CrFwDiscriminant_t
Type used for the discriminant of a command or report.
CrFwBool_t CrFwOutCmpIsInAborted(FwSmDesc_t smDesc)
Return true if the argument OutComponent is in state ABORTED.
Definition: CrFwOutCmp.c:153
unsigned char CrFwDestSrc_t
Type used for the command or report destination and source.
CrFwDiscriminant_t CrFwOutCmpGetDiscriminant(FwSmDesc_t smDesc)
Return the discriminant of the OutComponent.
Definition: CrFwOutCmp.c:251
CrFwPckt_t CrFwOutCmpGetParStart(FwSmDesc_t smDesc)
Return the start address of the parameter area of the OutComponent.
Definition: CrFwOutCmp.c:381
CrFwDestSrc_t CrFwOutCmpGetSrc(FwSmDesc_t smDesc)
Return the source of the OutComponent.
Definition: CrFwOutCmp.c:237
CrFwPcktLength_t CrFwOutCmpGetParLength(FwSmDesc_t smDesc)
Return the length in bytes of the parameter area of the OutComponent.
Definition: CrFwOutCmp.c:388
Definition and management of packet queues.
void CrFwOutCmpTerminate(FwSmDesc_t smDesc)
Send command Terminate to the argument OutComponent.
Definition: CrFwOutCmp.c:143
CrFwPckt_t CrFwOutCmpGetPckt(FwSmDesc_t smDesc)
Return the pointer to the packet which holds the OutComponent.
Definition: CrFwOutCmp.c:402
CrFwBool_t CrFwOutCmpIsInLoaded(FwSmDesc_t smDesc)
Return true if the argument OutComponent is in state LOADED.
Definition: CrFwOutCmp.c:148
CrFwGroup_t CrFwOutCmpGetGroup(FwSmDesc_t smDesc)
Return the group of the OutComponent.
Definition: CrFwOutCmp.c:200
void CrFwOutCmpSetDest(FwSmDesc_t smDesc, CrFwDestSrc_t dest)
Set the destination of the OutComponent.
Definition: CrFwOutCmp.c:192
CrFwServType_t CrFwOutCmpGetServSubType(FwSmDesc_t smDesc)
Return the sub-type of the OutComponent.
Definition: CrFwOutCmp.c:244
CrFwDestSrc_t CrFwOutCmpGetDest(FwSmDesc_t smDesc)
Return the destination of the OutComponent.
Definition: CrFwOutCmp.c:185
CrFwTimeStamp_t CrFwOutCmpGetTimeStamp(FwSmDesc_t smDesc)
Return the time stamp attribute of the OutComponent.
Definition: CrFwOutCmp.c:215
unsigned int CrFwTimeStamp_t
Type used for the time stamp of a command or report.
FwSmDesc_t CrFwOutCmpMakeBase()
Return the base OutComponent from which all other OutComponents are derived.
Definition: CrFwOutCmp.c:105
static CrFwDestSrc_t dest
Destination.
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
CrFwBool_t CrFwOutCmpIsInPending(FwSmDesc_t smDesc)
Return true if the argument OutComponent is in state PENDING.
Definition: CrFwOutCmp.c:158
unsigned short int CrFwPcktLength_t
Type for the packet length.
void CrFwOutCmpSetTimeStamp(FwSmDesc_t smDesc, CrFwTimeStamp_t timeStamp)
Set the time stamp attribute of the OutComponent.
Definition: CrFwOutCmp.c:222
CrFwBool_t CrFwOutCmpIsAcceptAck(FwSmDesc_t smDesc)
Return the acknowledge level for command acceptance for the command encapsulated in the OutComponent...
Definition: CrFwOutCmp.c:274
void CrFwOutCmpSetDiscriminant(FwSmDesc_t smDesc, CrFwDiscriminant_t discriminant)
Set the discriminant of the OutComponent.
Definition: CrFwOutCmp.c:258
unsigned char CrFwServType_t
Type used for the service type of a command or report.
CrFwBool_t CrFwOutCmpIsProgressAck(FwSmDesc_t smDesc)
Return the acknowledge level for command progress for the command encapsulated in the OutComponent...
Definition: CrFwOutCmp.c:288
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved