CORDET Framework - C2 Implementation
CrFwOutCmpSample1.h File Reference

Sample OutComponent used in the Test Suite. More...

Go to the source code of this file.

Functions

CrFwBool_t CrFwOutCmpSample1EnableCheck (FwSmDesc_t smDesc)
 Implementation of the Enable Check Operation for the Sample 1 OutComponent. More...
 
CrFwBool_t CrFwOutCmpSample1ReadyCheck (FwSmDesc_t smDesc)
 Implementation of the Ready Check Operation for the Sample 1 OutComponent. More...
 
CrFwBool_t CrFwOutCmpSample1RepeatCheck (FwSmDesc_t smDesc)
 Implementation of the Repeat Check Operation for the Sample 1 OutComponent. More...
 
void CrFwOutCmpSample1UpdateAction (FwSmDesc_t smDesc)
 Implementation of the Update Operation for the Sample 1 OutComponent. More...
 
void CrFwOutCmpSample1Serialize (FwSmDesc_t smDesc)
 Implementation of the Serialize Operation for the Sample 1 OutComponent. More...
 
CrFwPckt_t CrFwOutCmpSample1GetPckt (FwSmDesc_t smDesc)
 Return the packet associated to the Sample 1 OutComponent. More...
 
void CrFwOutCmpSample1SetEnableFlag (CrFwBool_t flag)
 Set the value of Enable Flag (see CrFwOutCmpSample1EnableCheck). More...
 
void CrFwOutCmpSample1SetReadyFlag (CrFwBool_t flag)
 Set the value of Ready Flag (see CrFwOutCmpSample1ReadyCheck). More...
 
void CrFwOutCmpSample1SetRepeatFlag (CrFwBool_t flag)
 Set the value of Repeat Flag (see CrFwOutCmpSample1RepeatCheck). More...
 
void CrFwOutCmpSample1SetCounter (unsigned char cnt)
 Set the value of Sample 1 Counter (see CrFwOutCmpSample1Serialize). More...
 

Detailed Description

Sample OutComponent used in the Test Suite.

An OutComponent is defined by defining the functions which override its adaptation points, namely (see CrFwOutCmp.h):

  • The Enable Check Operation
  • The Ready Check Operation
  • The Serialize Operation

This module defines three functions which implement the above operations. These functions are associated to a specific kind of OutComponent in the initializer CR_FW_OUTCMP_INIT_KIND_DESC.

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 CrFwOutCmpSample1.h.

Function Documentation

◆ CrFwOutCmpSample1EnableCheck()

CrFwBool_t CrFwOutCmpSample1EnableCheck ( FwSmDesc_t  smDesc)

Implementation of the Enable Check Operation for the Sample 1 OutComponent.

This function returns the value of an internal flag (the Enable Flag) whose value is set through function CrFwOutCmpSample1SetEnableFlag.

Parameters
smDescthe descriptor of the OutComponent state machine
Returns
the value of the Enable Flag

Definition at line 51 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1GetPckt()

CrFwPckt_t CrFwOutCmpSample1GetPckt ( FwSmDesc_t  smDesc)

Return the packet associated to the Sample 1 OutComponent.

This function is useful to check the effects of the OutComponent serialization. Note that, at some stage, the packet will be released and the pointer returned by this function will therefore become invalid.

Parameters
smDescthe descriptor of the OutComponent state machine
Returns
the packet associated to the OutComponent

Definition at line 82 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1ReadyCheck()

CrFwBool_t CrFwOutCmpSample1ReadyCheck ( FwSmDesc_t  smDesc)

Implementation of the Ready Check Operation for the Sample 1 OutComponent.

This function returns the value of an internal flag (the Ready Flag) whose value is set through function CrFwOutCmpSample1SetReadyFlag.

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

Definition at line 57 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1RepeatCheck()

CrFwBool_t CrFwOutCmpSample1RepeatCheck ( FwSmDesc_t  smDesc)

Implementation of the Repeat Check Operation for the Sample 1 OutComponent.

This function returns the value of an internal flag (the Repeat Flag) whose value is set through function CrFwOutCmpSample1SetRepeatFlag.

Parameters
smDescthe descriptor of the OutComponent state machine
Returns
the value of the Repeat Flag

Definition at line 63 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1Serialize()

void CrFwOutCmpSample1Serialize ( FwSmDesc_t  smDesc)

Implementation of the Serialize Operation for the Sample 1 OutComponent.

This function calls the default serialization function (CrFwOutCmpDefSerialize) and then sets byte N-2 of the packet associated to the OutComponent equal to the value of the Sample 1 Counter (N is the packet's length; the last two bytes are used for the CRC). The value of the Sample 1 Counter is set through function CrFwOutCmpSample1SetCounter.

Parameters
smDescthe descriptor of the OutComponent state machine

Definition at line 74 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1SetCounter()

void CrFwOutCmpSample1SetCounter ( unsigned char  cnt)

Set the value of Sample 1 Counter (see CrFwOutCmpSample1Serialize).

Parameters
cntthe counter

Definition at line 104 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1SetEnableFlag()

void CrFwOutCmpSample1SetEnableFlag ( CrFwBool_t  flag)

Set the value of Enable Flag (see CrFwOutCmpSample1EnableCheck).

Parameters
flagthe Enable Flag

Definition at line 89 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1SetReadyFlag()

void CrFwOutCmpSample1SetReadyFlag ( CrFwBool_t  flag)

Set the value of Ready Flag (see CrFwOutCmpSample1ReadyCheck).

Parameters
flagthe Ready Flag

Definition at line 94 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1SetRepeatFlag()

void CrFwOutCmpSample1SetRepeatFlag ( CrFwBool_t  flag)

Set the value of Repeat Flag (see CrFwOutCmpSample1RepeatCheck).

Parameters
flagthe Repeat Flag

Definition at line 99 of file CrFwOutCmpSample1.c.

◆ CrFwOutCmpSample1UpdateAction()

void CrFwOutCmpSample1UpdateAction ( FwSmDesc_t  smDesc)

Implementation of the Update Operation for the Sample 1 OutComponent.

This function increments the value of Sample 1 Counter by 1. The value of the Sample 1 Counter is set through function CrFwOutCmpSample1SetCounter.

Parameters
smDescthe descriptor of the OutComponent state machine

Definition at line 68 of file CrFwOutCmpSample1.c.

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