CORDET Framework - C2 Implementation
CrFwInRepSample1.h File Reference

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

Go to the source code of this file.

Functions

CrFwBool_t CrFwInRepSample1ValidityCheck (FwPrDesc_t prDesc)
 Implementation of the Validity Check Operation for the Sample 1 InReport. More...
 
void CrFwInRepSample1SetValidityFlag (CrFwBool_t flag)
 Set the value of the Validity Flag (see CrFwInRepSample1ValidityCheck). More...
 
void CrFwInRepSample1UpdateAction (FwPrDesc_t prDesc)
 Implementation of the Update Action Operation for the Sample 1 InReport. More...
 
void CrFwInRepSample1SetUpdateActionOutcome (CrFwOutcome_t outcome)
 Set the value of the Update Action Outcome (see CrFwInRepSample1UpdateAction). More...
 
CrFwCounterU1_t CrFwInRepSample1GetUpdateActionCounter ()
 Get the value of the Update Action Counter (see CrFwInRepSample1UpdateAction). More...
 
CrFwCounterU1_t CrFwInRepSample1GetType ()
 Get the value of the InReport's type as it is computed by the Validity Check (see CrFwInRepSample1ValidityCheck). More...
 

Detailed Description

Sample InReport used in the Test Suite.

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

  • The Validity Check Operation
  • The Update Action Operation

This module defines functions which implement the above operations. These functions are associated to a specific kind of InReport in the initializer CR_FW_INREP_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 CrFwInRepSample1.h.

Function Documentation

CrFwCounterU1_t CrFwInRepSample1GetType ( )

Get the value of the InReport's type as it is computed by the Validity Check (see CrFwInRepSample1ValidityCheck).

Returns
the value of the InReport's type compouted by the Validity Check

Definition at line 81 of file CrFwInRepSample1.c.

CrFwCounterU1_t CrFwInRepSample1GetUpdateActionCounter ( )

Get the value of the Update Action Counter (see CrFwInRepSample1UpdateAction).

Returns
the value of the Update Action Counter

Definition at line 76 of file CrFwInRepSample1.c.

void CrFwInRepSample1SetUpdateActionOutcome ( CrFwOutcome_t  outcome)

Set the value of the Update Action Outcome (see CrFwInRepSample1UpdateAction).

Parameters
outcomethe value of the Update Action Outcome

Definition at line 71 of file CrFwInRepSample1.c.

void CrFwInRepSample1SetValidityFlag ( CrFwBool_t  flag)

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

Parameters
flagthe value of the validity flag

Definition at line 59 of file CrFwInRepSample1.c.

void CrFwInRepSample1UpdateAction ( FwPrDesc_t  prDesc)

Implementation of the Update Action Operation for the Sample 1 InReport.

This function sets the outcome to the value of an internal flag (the Update Action Outcome) whose value is set through function CrFwInRepSample1SetUpdateActionOutcome and it increments the value of a counter (the Update Action Counter) whose value is read through function CrFwInRepSample1GetUpdateActionCounter.

Parameters
prDescthe descriptor of the InReport procedure

Definition at line 64 of file CrFwInRepSample1.c.

CrFwBool_t CrFwInRepSample1ValidityCheck ( FwPrDesc_t  prDesc)

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

This function: (a) stores the value of the InReport's type in an internal variable which can be accessed through function CrFwInRepSample1GetType, and (b) returns the value of an internal flag (the Validity Flag) whose value is set through function CrFwInRepSample1SetValidityFlag.

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

Definition at line 51 of file CrFwInRepSample1.c.

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