CORDET Framework - C2 Implementation
InCmdData Struct Reference

Type for the data describing an InCommand. More...

Data Fields

CrFwInFactoryPoolIndex_t factoryPoolIndex
 Index of the position in the pool of pre-allocated InCommands in the InFactory to which the InComponent has been allocated.
 
CrFwTrackingIndex_t trackingIndex
 Index through which an InCommand is tracked by the InRegistry (see CrFwInRegistry.h)
 
CrFwInCmdValidityCheck_t isValid
 Function which implements the Configuration Check for the InCommand.
 
CrFwInCmdReadyCheck_t isReady
 Function which implements the Ready Check for the InCommand.
 
CrFwInCmdStartAction_t startAction
 Function which implements the Start Action for the InCommand.
 
CrFwInCmdProgressAction_t progressAction
 Function which implements the Progress Action for the InCommand.
 
CrFwInCmdTerminationAction_t terminationAction
 Function which implements the Termination Action for the InCommand.
 
CrFwInCmdAbortAction_t abortAction
 Function which implements the Abort Action for the InCommand.
 
CrFwProgressStepId_t progressStepId
 The progress step identifier.
 
CrFwBool_t isProgressActionCompleted
 Flag indicating whether the progress action has been completed. More...
 
CrFwExecStepId_t nOfProgressFailure
 Number of progress steps which failed.
 
CrFwPckt_t pckt
 Packet holding the InCommand.
 

Detailed Description

Type for the data describing an InCommand.

Definition at line 481 of file CrFwConstants.h.

Field Documentation

CrFwBool_t isProgressActionCompleted

Flag indicating whether the progress action has been completed.

An InCommand sets the flag to false at entry in the PROGRESS state. The progress action must set it to true when all progress steps have been completed.

Definition at line 512 of file CrFwConstants.h.


The documentation for this struct was generated from the following file:
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved