CORDET Framework - C2 Implementation
CrFwRepInCmdOutcomeStub.h File Reference

The CORDET Framework defines an interface for reporting the outcome of an InCommand (see CrFwRepInCmdOutcome.h). More...

Go to the source code of this file.

Functions

CrFwCounterU2_t CrFwRepInCmdOutcomeStubGetPos ()
 Return the position in the InCommand Outcome Report array at which the next outcome report will be written. More...
 
void CrFwRepInCmdOutcomeStubReset ()
 Reset the InCommand Outcome Reporting interface. More...
 
CrFwRepInCmdOutcome_t CrFwRepInCmdOutcomeStubGetOutcome (CrFwCounterU2_t repPos)
 Return the outcome of the InCommand Outcome Report at position repPos. More...
 
CrFwOutcome_t CrFwRepInCmdOutcomeStubGetFailCode (CrFwCounterU2_t repPos)
 Return the failure code of the InCommand Outcome Report at position repPos. More...
 
CrFwInstanceId_t CrFwRepInCmdOutcomeStubGetInstanceId (CrFwCounterU2_t repPos)
 Return the instance identifier of the InCommand Outcome Report at position repPos. More...
 
CrFwServType_t CrFwRepInCmdOutcomeStubGetServType (CrFwCounterU2_t repPos)
 Return the service type of the InCommand Outcome Report at position repPos. More...
 
CrFwServSubType_t CrFwRepInCmdOutcomeStubGetServSubType (CrFwCounterU2_t repPos)
 Return the service sub-type of the InCommand Outcome Report at position repPos. More...
 
CrFwDiscriminant_t CrFwRepInCmdOutcomeStubGetDiscriminant (CrFwCounterU2_t repPos)
 Return the discriminant of the InCommand Outcome Report at position repPos. More...
 

Detailed Description

The CORDET Framework defines an interface for reporting the outcome of an InCommand (see CrFwRepInCmdOutcome.h).

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

  • CrFwRepInCmdOutcome.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 CrFwRepInCmdOutcomeStub.h.

Function Documentation

CrFwDiscriminant_t CrFwRepInCmdOutcomeStubGetDiscriminant ( CrFwCounterU2_t  repPos)

Return the discriminant of the InCommand Outcome Report at position repPos.

This function is provided for convenience during testing. It is not part of the InCommand Outcome Reporting interface.

Parameters
repPosthe position in the InCommand Outcome Report array
Returns
the service type

Definition at line 136 of file CrFwRepInCmdOutcome.c.

CrFwOutcome_t CrFwRepInCmdOutcomeStubGetFailCode ( CrFwCounterU2_t  repPos)

Return the failure code of the InCommand Outcome Report at position repPos.

This function is provided for convenience during testing. It is not part of the InCommand Outcome Reporting interface.

Parameters
repPosthe position in the InCommand Outcome Report array
Returns
the failure code

Definition at line 116 of file CrFwRepInCmdOutcome.c.

CrFwInstanceId_t CrFwRepInCmdOutcomeStubGetInstanceId ( CrFwCounterU2_t  repPos)

Return the instance identifier of the InCommand Outcome Report at position repPos.

This function is provided for convenience during testing. It is not part of the InCommand Outcome Reporting interface.

Parameters
repPosthe position in the InCommand Outcome Report array
Returns
the instance identifier

Definition at line 121 of file CrFwRepInCmdOutcome.c.

CrFwRepInCmdOutcome_t CrFwRepInCmdOutcomeStubGetOutcome ( CrFwCounterU2_t  repPos)

Return the outcome of the InCommand Outcome Report at position repPos.

This function is provided for convenience during testing. It is not part of the InCommand Outcome Reporting interface.

Parameters
repPosthe position in the InCommand Outcome Report array
Returns
the outcome

Definition at line 111 of file CrFwRepInCmdOutcome.c.

CrFwCounterU2_t CrFwRepInCmdOutcomeStubGetPos ( )

Return the position in the InCommand Outcome Report array at which the next outcome report will be written.

Returns
the position in the InCommand Outcome Report array at which the next outcome report will be written

Definition at line 70 of file CrFwRepInCmdOutcome.c.

CrFwServSubType_t CrFwRepInCmdOutcomeStubGetServSubType ( CrFwCounterU2_t  repPos)

Return the service sub-type of the InCommand Outcome Report at position repPos.

This function is provided for convenience during testing. It is not part of the InCommand Outcome Reporting interface.

Parameters
repPosthe position in the InCommand Outcome Report array
Returns
the service sub-type

Definition at line 131 of file CrFwRepInCmdOutcome.c.

CrFwServType_t CrFwRepInCmdOutcomeStubGetServType ( CrFwCounterU2_t  repPos)

Return the service type of the InCommand Outcome Report at position repPos.

This function is provided for convenience during testing. It is not part of the InCommand Outcome Reporting interface.

Parameters
repPosthe position in the InCommand Outcome Report array
Returns
the service type

Definition at line 126 of file CrFwRepInCmdOutcome.c.

void CrFwRepInCmdOutcomeStubReset ( )

Reset the InCommand Outcome Reporting interface.

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

Definition at line 75 of file CrFwRepInCmdOutcome.c.

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