CORDET Framework - C2 Implementation
CrFwRepErrStub.h File Reference

The CORDET Framework defines an interface for generating error reports (see CrFwRepErr.h). More...

Go to the source code of this file.

Functions

CrFwCounterU2_t CrFwRepErrStubGetPos ()
 Return the position in the error report array at which the next error report will be written. More...
 
void CrFwRepErrStubReset ()
 Reset the error reporting interface. More...
 
CrFwRepErrCode_t CrFwRepErrStubGetErrCode (CrFwCounterU2_t errRepPos)
 Return the error code of the error report at position errRepPos. More...
 
CrFwTypeId_t CrFwRepErrStubGetTypeId (CrFwCounterU2_t errRepPos)
 Return the type identifier of the error report at position errRepPos. More...
 
CrFwInstanceId_t CrFwRepErrStubGetInstanceId (CrFwCounterU2_t errRepPos)
 Return the type identifier of the error report at position errRepPos. More...
 
CrFwCounterU1_tCrFwRepErrStubGetParArray (CrFwCounterU2_t errRepPos)
 Return the array holding the parameters associated to the error report at position errRepPos. More...
 
CrFwDestSrc_t CrFwRepErrStubGetDest (CrFwCounterU2_t errRepPos)
 Return the destination associated to the error report at position errRepPos. More...
 
CrFwSeqCnt_t CrFwRepErrStubGetExpSeqCnt (CrFwCounterU2_t errRepPos)
 Return the expected sequence counter associated to the error report at position errRepPos. More...
 
CrFwSeqCnt_t CrFwRepErrStubGetActualSeqCnt (CrFwCounterU2_t errRepPos)
 Return the actual sequence counter associated to the error report at position errRepPos. More...
 
CrFwInstanceId_t CrFwRepErrStubGetSecondatyInstanceId (CrFwCounterU2_t errRepPos)
 Return the secondary instance identifier associated to the error report at position errRepPos. More...
 
CrFwOutcome_t CrFwRepErrStubGetOutcome (CrFwCounterU2_t errRepPos)
 Return the outcome associated to the error report at position errRepPos. More...
 

Detailed Description

The CORDET Framework defines an interface for generating error reports (see CrFwRepErr.h).

A stub implementation for this interface is provided in CrFwRepErr.c. The present module defines the public functions which are implemented by CrFwRepErr.c but which are not declared in CrFwRepErr.h. Thus, the complete interface of the error reporting stub implemented in CrFwRepErr.c is provided in:

  • CrFwRepErr.h (interface defined at framework level)
  • this module (interface defined for testing purposes)
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 CrFwRepErrStub.h.

Function Documentation

CrFwSeqCnt_t CrFwRepErrStubGetActualSeqCnt ( CrFwCounterU2_t  errRepPos)

Return the actual sequence counter associated to the error report at position errRepPos.

This function assumes that the error report at position errRepPos was created with a call to CrFwRepErrSeqCnt.

Parameters
errRepPosthe position in the error reporting array
Returns
the actual sequence counter

Definition at line 290 of file CrFwRepErr.c.

CrFwDestSrc_t CrFwRepErrStubGetDest ( CrFwCounterU2_t  errRepPos)

Return the destination associated to the error report at position errRepPos.

This function assumes that the error report at position errRepPos was created with a call to CrFwRepErrDestSrc.

Parameters
errRepPosthe position in the error reporting array
Returns
the destination

Definition at line 279 of file CrFwRepErr.c.

CrFwRepErrCode_t CrFwRepErrStubGetErrCode ( CrFwCounterU2_t  errRepPos)

Return the error code of the error report at position errRepPos.

This function is provided for convenience during testing. It is not part of the error reporting interface.

Parameters
errRepPosthe position in the error reporting array
Returns
the error code

Definition at line 259 of file CrFwRepErr.c.

CrFwSeqCnt_t CrFwRepErrStubGetExpSeqCnt ( CrFwCounterU2_t  errRepPos)

Return the expected sequence counter associated to the error report at position errRepPos.

This function assumes that the error report at position errRepPos was created with a call to CrFwRepErrSeqCnt.

Parameters
errRepPosthe position in the error reporting array
Returns
the expected sequence counter

Definition at line 284 of file CrFwRepErr.c.

CrFwInstanceId_t CrFwRepErrStubGetInstanceId ( CrFwCounterU2_t  errRepPos)

Return the type identifier of the error report at position errRepPos.

This function is provided for convenience during testing. It is not part of the error reporting interface.

Parameters
errRepPosthe position in the error reporting array
Returns
the error code

Definition at line 269 of file CrFwRepErr.c.

CrFwOutcome_t CrFwRepErrStubGetOutcome ( CrFwCounterU2_t  errRepPos)

Return the outcome associated to the error report at position errRepPos.

This function assumes that the error report at position errRepPos was created with a call to CrFwRepErrInstanceIdAndOutcome.

Parameters
errRepPosthe position in the error reporting array
Returns
the value of the outcome

Definition at line 301 of file CrFwRepErr.c.

CrFwCounterU1_t* CrFwRepErrStubGetParArray ( CrFwCounterU2_t  errRepPos)

Return the array holding the parameters associated to the error report at position errRepPos.

This function is provided for convenience during testing. It is not part of the error reporting interface.

Parameters
errRepPosthe position in the error reporting array
Returns
the error code

Definition at line 274 of file CrFwRepErr.c.

CrFwCounterU2_t CrFwRepErrStubGetPos ( )

Return the position in the error report array at which the next error report will be written.

Returns
the position in the error report array at which the next error report will be written

Definition at line 71 of file CrFwRepErr.c.

CrFwInstanceId_t CrFwRepErrStubGetSecondatyInstanceId ( CrFwCounterU2_t  errRepPos)

Return the secondary instance identifier associated to the error report at position errRepPos.

This function assumes that the error report at position errRepPos was created with a call to CrFwRepErrInstanceIdAndOutcome.

Parameters
errRepPosthe position in the error reporting array
Returns
the secondary instance identifier

Definition at line 296 of file CrFwRepErr.c.

CrFwTypeId_t CrFwRepErrStubGetTypeId ( CrFwCounterU2_t  errRepPos)

Return the type identifier of the error report at position errRepPos.

This function is provided for convenience during testing. It is not part of the error reporting interface.

Parameters
errRepPosthe position in the error reporting array
Returns
the error code

Definition at line 264 of file CrFwRepErr.c.

void CrFwRepErrStubReset ( )

Reset the error reporting interface.

This effectively deletes all error reports created since the last reset.

Definition at line 76 of file CrFwRepErr.c.

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