|
CORDET Framework - C2 Implementation
|
Sample InCommand used in the Test Suite. More...
Go to the source code of this file.
Functions | |
| CrFwBool_t | CrFwInCmdSample1ValidityCheck (FwPrDesc_t prDesc) |
| Implementation of the Validity Check Operation for the Sample 1 InCommand. More... | |
| void | CrFwInCmdSample1SetValidityFlag (CrFwBool_t flag) |
Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck). More... | |
| CrFwServType_t | CrFwInCmdSample1GetType () |
Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck). More... | |
| CrFwBool_t | CrFwInCmdSample1ReadyCheck (FwSmDesc_t smDesc) |
| Implementation of the Ready Check Operation for the Sample 1 InCommand. More... | |
| void | CrFwInCmdSample1SetReadyFlag (CrFwBool_t flag) |
Set the value of the Ready Flag (see CrFwInCmdSample1ReadyCheck). More... | |
| void | CrFwInCmdSample1StartAction (FwSmDesc_t smDesc) |
| Implementation of the Start Action Operation for the Sample 1 InCommand. More... | |
| void | CrFwInCmdSample1SetStartActionOutcome (CrFwOutcome_t outcome) |
Set the value of the Start Action Outcome Counter (see CrFwInCmdSample1StartAction). More... | |
| CrFwCounterU1_t | CrFwInCmdSample1GetStartActionCounter () |
Get the value of the Start Action Counter (see CrFwInCmdSample1StartAction). More... | |
| void | CrFwInCmdSample1ProgressAction (FwSmDesc_t smDesc) |
| Implementation of the Progress Action Operation for the Sample 1 InCommand. More... | |
| void | CrFwInCmdSample1SetProgressStepFlag (CrFwBool_t flag) |
| Sets the progress step flag used by the progress action of the sample InCommand (if the flag is set, the progress action increments the progress step identifier). More... | |
| void | CrFwInCmdSample1SetProgressActionOutcome (CrFwOutcome_t outcome) |
Set the value of the Progress Action Outcome (see CrFwInCmdSample1ProgressAction). More... | |
| void | CrFwInCmdSample1SetProgressActionCompletionOutcome (CrFwOutcome_t outcome) |
Set the value of the Progress Action Completion Outcome (see CrFwInCmdSample1ProgressAction). More... | |
| CrFwCounterU1_t | CrFwInCmdSample1GetProgressActionCounter () |
Get the value of the Progress Action Counter (see CrFwInCmdSample1ProgressAction). More... | |
| void | CrFwInCmdSample1AbortAction (FwSmDesc_t smDesc) |
| Implementation of the Abort Action Operation for the Sample 1 InCommand. More... | |
| void | CrFwInCmdSample1SetAbortActionOutcome (CrFwOutcome_t outcome) |
Set the value of the Abort Action Outcome Counter (see CrFwInCmdSample1AbortAction). More... | |
| CrFwCounterU1_t | CrFwInCmdSample1GetAbortActionCounter () |
Get the value of the Abort Action Counter (see CrFwInCmdSample1AbortAction). More... | |
| void | CrFwInCmdSample1TerminationAction (FwSmDesc_t smDesc) |
| Implementation of the Termination Action Operation for the Sample 1 InCommand. More... | |
| void | CrFwInCmdSample1SetTerminationActionOutcome (CrFwOutcome_t outcome) |
Set the value of the Termination Action Outcome Counter (see CrFwInCmdSample1TerminationAction). More... | |
| CrFwCounterU1_t | CrFwInCmdSample1GetTerminationActionCounter () |
Get the value of the Termination Action Counter (see CrFwInCmdSample1TerminationAction). More... | |
Sample InCommand used in the Test Suite.
An InCommand is defined by defining the functions which override its adaptation points, namely (see CrFwInCmd.h):
This module defines functions which implement the above operations. These functions are associated to a specific kind of InCommand in the initializer CR_FW_INCMD_INIT_KIND_DESC.
This file is part of the CORDET Framework.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
For information on alternative licensing, please contact P&P Software GmbH.
Definition in file CrFwInCmdSample1.h.
| void CrFwInCmdSample1AbortAction | ( | FwSmDesc_t | smDesc | ) |
Implementation of the Abort Action Operation for the Sample 1 InCommand.
This function sets the outcome to the value of an internal counter (the Abort Action Outcome Counter) whose value is set through function CrFwInCmdSample1SetAbortActionOutcome and it increments the value of a counter (the Abort Action Counter) whose value is read through function CrFwInCmdSample1GetAbortActionCounter.
| smDesc | the descriptor of the InCommand state machine |
Definition at line 156 of file CrFwInCmdSample1.c.
| CrFwCounterU1_t CrFwInCmdSample1GetAbortActionCounter | ( | ) |
Get the value of the Abort Action Counter (see CrFwInCmdSample1AbortAction).
Definition at line 167 of file CrFwInCmdSample1.c.
| CrFwCounterU1_t CrFwInCmdSample1GetProgressActionCounter | ( | ) |
Get the value of the Progress Action Counter (see CrFwInCmdSample1ProgressAction).
Definition at line 151 of file CrFwInCmdSample1.c.
| CrFwCounterU1_t CrFwInCmdSample1GetStartActionCounter | ( | ) |
Get the value of the Start Action Counter (see CrFwInCmdSample1StartAction).
Definition at line 124 of file CrFwInCmdSample1.c.
| CrFwCounterU1_t CrFwInCmdSample1GetTerminationActionCounter | ( | ) |
Get the value of the Termination Action Counter (see CrFwInCmdSample1TerminationAction).
Definition at line 183 of file CrFwInCmdSample1.c.
| CrFwServType_t CrFwInCmdSample1GetType | ( | ) |
Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck).
CrFwInCmdSample1ValidityCheck Definition at line 87 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1ProgressAction | ( | FwSmDesc_t | smDesc | ) |
Implementation of the Progress Action Operation for the Sample 1 InCommand.
This function:
CrFwInCmdSample1SetProgressActionOutcome, andCrFwInCmdSample1SetProgressStepFlag.CrFwInCmdSample1SetProgressActionCompletionOutcome.| smDesc | the descriptor of the InCommand state machine |
Definition at line 129 of file CrFwInCmdSample1.c.
| CrFwBool_t CrFwInCmdSample1ReadyCheck | ( | FwSmDesc_t | smDesc | ) |
Implementation of the Ready Check Operation for the Sample 1 InCommand.
This function returns the value of an internal flag (the Ready Flag) whose value is set through function CrFwInCmdSample1SetReadyFlag.
| smDesc | the descriptor of the InCommand state machine |
Definition at line 102 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetAbortActionOutcome | ( | CrFwOutcome_t | outcome | ) |
Set the value of the Abort Action Outcome Counter (see CrFwInCmdSample1AbortAction).
| outcome | the value of the Abort Action Outcome |
Definition at line 162 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetProgressActionCompletionOutcome | ( | CrFwOutcome_t | outcome | ) |
Set the value of the Progress Action Completion Outcome (see CrFwInCmdSample1ProgressAction).
| outcome | the value of the Progress Action Completion Outcome |
Definition at line 146 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetProgressActionOutcome | ( | CrFwOutcome_t | outcome | ) |
Set the value of the Progress Action Outcome (see CrFwInCmdSample1ProgressAction).
| outcome | the value of the Progress Action Outcome |
Definition at line 141 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetProgressStepFlag | ( | CrFwBool_t | flag | ) |
Sets the progress step flag used by the progress action of the sample InCommand (if the flag is set, the progress action increments the progress step identifier).
| flag | the value of the progress step flag |
Definition at line 92 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetReadyFlag | ( | CrFwBool_t | flag | ) |
Set the value of the Ready Flag (see CrFwInCmdSample1ReadyCheck).
| flag | the value of the ready flag |
Definition at line 108 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetStartActionOutcome | ( | CrFwOutcome_t | outcome | ) |
Set the value of the Start Action Outcome Counter (see CrFwInCmdSample1StartAction).
| outcome | the value of the Start Action Outcome |
Definition at line 119 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetTerminationActionOutcome | ( | CrFwOutcome_t | outcome | ) |
Set the value of the Termination Action Outcome Counter (see CrFwInCmdSample1TerminationAction).
| outcome | the value of the Termination Action Outcome |
Definition at line 178 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1SetValidityFlag | ( | CrFwBool_t | flag | ) |
Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck).
| flag | the value of the validity flag |
Definition at line 97 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1StartAction | ( | FwSmDesc_t | smDesc | ) |
Implementation of the Start Action Operation for the Sample 1 InCommand.
This function sets the outcome to the value of an internal counter (the Start Action Outcome Counter) whose value is set through function CrFwInCmdSample1SetStartActionOutcome and it increments the value of a counter (the Start Action Counter) whose value is read through function CrFwInCmdSample1GetStartActionCounter.
| smDesc | the descriptor of the InCommand state machine |
Definition at line 113 of file CrFwInCmdSample1.c.
| void CrFwInCmdSample1TerminationAction | ( | FwSmDesc_t | smDesc | ) |
Implementation of the Termination Action Operation for the Sample 1 InCommand.
This function sets the outcome to the value of an internal counter (the Termination Action Outcome Counter) whose value is set through function CrFwInCmdSample1SetTerminationActionOutcome and it increments the value of a counter (the Termination Action Counter) whose value is read through function CrFwInCmdSample1GetTerminationActionCounter.
| smDesc | the descriptor of the InCommand state machine |
Definition at line 172 of file CrFwInCmdSample1.c.
| CrFwBool_t CrFwInCmdSample1ValidityCheck | ( | FwPrDesc_t | prDesc | ) |
Implementation of the Validity Check Operation for the Sample 1 InCommand.
This function:
CrFwInCmdGetPcktFromPrDesc to access the InCommand type and loads it in an internal variable which can be accessed with function CrFwInCmdSample1GetType.CrFwInCmdSample1SetValidityFlag.| prDesc | the descriptor of the InCommand reset procedure |
Definition at line 79 of file CrFwInCmdSample1.c.