CORDET Framework - C2 Implementation
CrFwInCmdSample1.c File Reference

Implementation of the Sample 1 InCommand. 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...
 
CrFwServType_t CrFwInCmdSample1GetType ()
 Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck). 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 CrFwInCmdSample1SetValidityFlag (CrFwBool_t flag)
 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 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...
 

Variables

static CrFwBool_t validityFlag
 The Validity Flag.
 
static CrFwServType_t servType = 0
 The InCommand type as computed in the Validity Check.
 
static CrFwBool_t readyFlag
 The Ready Flag.
 
static CrFwOutcome_t startOutcome
 The Start Action Outcome.
 
static CrFwOutcome_t progressOutcome
 The Progress Action Outcome.
 
static CrFwOutcome_t progressCompletionOutcome
 The Progress Action Completion Outcome.
 
static CrFwBool_t progressStepFlag
 The Progress Step Flag.
 
static CrFwOutcome_t abortOutcome = 0
 The Abort Action Outcome.
 
static CrFwOutcome_t terminationOutcome
 The Termination Action Outcome.
 
static CrFwCounterU1_t startCounter = 0
 The Start Action Counter.
 
static CrFwCounterU1_t progressCounter = 0
 The Progress Action Counter.
 
static CrFwCounterU1_t terminationCounter = 0
 The Termination Action Counter.
 
static CrFwCounterU1_t abortCounter = 0
 The abort Action Counter.
 

Detailed Description

Implementation of the Sample 1 InCommand.

Author
Vaclav Cechticky vacla.nosp@m.v.ce.nosp@m.chtic.nosp@m.ky@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m
Alessandro Pasetti paset.nosp@m.ti@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m

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.c.

Function Documentation

◆ CrFwInCmdSample1AbortAction()

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.

Parameters
smDescthe descriptor of the InCommand state machine

Definition at line 156 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1GetAbortActionCounter()

CrFwCounterU1_t CrFwInCmdSample1GetAbortActionCounter ( )

Get the value of the Abort Action Counter (see CrFwInCmdSample1AbortAction).

Returns
the value of the Abort Action Counter

Definition at line 167 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1GetProgressActionCounter()

CrFwCounterU1_t CrFwInCmdSample1GetProgressActionCounter ( )

Get the value of the Progress Action Counter (see CrFwInCmdSample1ProgressAction).

Returns
the value of the Progress Action Counter

Definition at line 151 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1GetStartActionCounter()

CrFwCounterU1_t CrFwInCmdSample1GetStartActionCounter ( )

Get the value of the Start Action Counter (see CrFwInCmdSample1StartAction).

Returns
the value of the Start Action Counter

Definition at line 124 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1GetTerminationActionCounter()

CrFwCounterU1_t CrFwInCmdSample1GetTerminationActionCounter ( )

Get the value of the Termination Action Counter (see CrFwInCmdSample1TerminationAction).

Returns
the value of the Termination Action Counter

Definition at line 183 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1GetType()

CrFwServType_t CrFwInCmdSample1GetType ( )

Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck).

Returns
the value of the InCommand type computed by the validity check function CrFwInCmdSample1ValidityCheck

Definition at line 87 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1ProgressAction()

void CrFwInCmdSample1ProgressAction ( FwSmDesc_t  smDesc)

Implementation of the Progress Action Operation for the Sample 1 InCommand.

This function:

Parameters
smDescthe descriptor of the InCommand state machine

Definition at line 129 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1ReadyCheck()

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.

Parameters
smDescthe descriptor of the InCommand state machine
Returns
the value of the Ready Flag

Definition at line 102 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetAbortActionOutcome()

void CrFwInCmdSample1SetAbortActionOutcome ( CrFwOutcome_t  outcome)

Set the value of the Abort Action Outcome Counter (see CrFwInCmdSample1AbortAction).

Parameters
outcomethe value of the Abort Action Outcome

Definition at line 162 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetProgressActionCompletionOutcome()

void CrFwInCmdSample1SetProgressActionCompletionOutcome ( CrFwOutcome_t  outcome)

Set the value of the Progress Action Completion Outcome (see CrFwInCmdSample1ProgressAction).

Parameters
outcomethe value of the Progress Action Completion Outcome

Definition at line 146 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetProgressActionOutcome()

void CrFwInCmdSample1SetProgressActionOutcome ( CrFwOutcome_t  outcome)

Set the value of the Progress Action Outcome (see CrFwInCmdSample1ProgressAction).

Parameters
outcomethe value of the Progress Action Outcome

Definition at line 141 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetProgressStepFlag()

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).

Parameters
flagthe value of the progress step flag

Definition at line 92 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetReadyFlag()

void CrFwInCmdSample1SetReadyFlag ( CrFwBool_t  flag)

Set the value of the Ready Flag (see CrFwInCmdSample1ReadyCheck).

Parameters
flagthe value of the ready flag

Definition at line 108 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetStartActionOutcome()

void CrFwInCmdSample1SetStartActionOutcome ( CrFwOutcome_t  outcome)

Set the value of the Start Action Outcome Counter (see CrFwInCmdSample1StartAction).

Parameters
outcomethe value of the Start Action Outcome

Definition at line 119 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetTerminationActionOutcome()

void CrFwInCmdSample1SetTerminationActionOutcome ( CrFwOutcome_t  outcome)

Set the value of the Termination Action Outcome Counter (see CrFwInCmdSample1TerminationAction).

Parameters
outcomethe value of the Termination Action Outcome

Definition at line 178 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1SetValidityFlag()

void CrFwInCmdSample1SetValidityFlag ( CrFwBool_t  flag)

Set the value of the Validity Flag (see CrFwInCmdSample1ValidityCheck).

Parameters
flagthe value of the validity flag

Definition at line 97 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1StartAction()

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.

Parameters
smDescthe descriptor of the InCommand state machine

Definition at line 113 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1TerminationAction()

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.

Parameters
smDescthe descriptor of the InCommand state machine

Definition at line 172 of file CrFwInCmdSample1.c.

◆ CrFwInCmdSample1ValidityCheck()

CrFwBool_t CrFwInCmdSample1ValidityCheck ( FwPrDesc_t  prDesc)

Implementation of the Validity Check Operation for the Sample 1 InCommand.

This function:

Parameters
prDescthe descriptor of the InCommand reset procedure
Returns
the value of Validity Flag

Definition at line 79 of file CrFwInCmdSample1.c.

P&P Software GmbH, Copyright 2012-2013, All Rights Reserved