CORDET Framework - C2 Implementation
CrPsRepErr.h File Reference

Interface for reporting an error detected by a PUS Extension component. More...

Go to the source code of this file.

Functions

void CrPsRepErr (CrPsRepErrCode_t errCode, CrFwServType_t repType, CrFwServSubType_t repSubType, CrFwDiscriminant_t repDiscriminant)
 Report an error which has no parameters attached to it. More...
 
void CrFwRepErrInstanceIdAndDest (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwInstanceId_t secondaryInstanceId, CrFwDestSrc_t dest)
 Report an error which has two parameters attached to it representing the instance identifier of a component other than the originator of the error report (the secondary instance identifier) and a command or report destination. More...
 

Detailed Description

Interface for reporting an error detected by a PUS Extension component.

When a PUS Extension component encounters an error, it reports it by calling one of the functions defined by this header file (error report).

An error report is defined by the following attributes:

  • The error code: a positive integer which identifies the type of error.
  • The source type identifier: the type identifier of the component which generated the error report.
  • The source instance identifier: the instance identifier of the component which generated the error report.
  • The error parameters: any additional parameters which are useful to characterize the circumstances in which the error arose.

The type and number of error parameters depends on the type of error which is being reported. This interface defines several error reporting functions, one for each set of error parameter types.

In general, the implementation of this interface is entirely application-specific but a simple default implementation is provided in CrFwRepErr.c. This default implementation is primarily intended for testing and demonstration purposes.

Author
Christian Reimers chris.nosp@m.tian.nosp@m..reim.nosp@m.ersy.nosp@m.@univ.nosp@m.ie.a.nosp@m.c.at
Markus Rockenbauer marku.nosp@m.s.ro.nosp@m.ckenb.nosp@m.auer.nosp@m.@univ.nosp@m.ie.a.nosp@m.c.at

last modification: 22.01.2018

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

Definition in file CrPsRepErr.h.

Function Documentation

void CrFwRepErrInstanceIdAndDest ( CrFwRepErrCode_t  errCode,
CrFwTypeId_t  typeId,
CrFwInstanceId_t  instanceId,
CrFwInstanceId_t  secondaryInstanceId,
CrFwDestSrc_t  dest 
)

Report an error which has two parameters attached to it representing the instance identifier of a component other than the originator of the error report (the secondary instance identifier) and a command or report destination.

This function generate an error report with two parameters.

Parameters
errCodethe error code
instanceIdthe instance identifier of the component which raises the error report
typeIdthe type identifier of the component which raises the error report
secondaryInstanceIdinstance identifier of a component other than the originator of the error report
desta command or report destination

Definition at line 51 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwRepErr.c.

void CrPsRepErr ( CrPsRepErrCode_t  errCode,
CrFwServType_t  repType,
CrFwServSubType_t  repSubType,
CrFwDiscriminant_t  repDiscriminant 
)

Report an error which has no parameters attached to it.

This function generate an error report without error parameters.

Parameters
errCodethe error code
repTypethe type of the component which raises the error report
repServSubTypethe sub type of the component which raises the error report
repDiscriminantthe discriminant of the component which raises the error report

Definition at line 37 of file CrPsRepErr.c.

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