CORDET Framework - C2 Implementation
|
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... | |
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 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.
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.
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.
errCode | the error code |
instanceId | the instance identifier of the component which raises the error report |
typeId | the type identifier of the component which raises the error report |
secondaryInstanceId | instance identifier of a component other than the originator of the error report |
dest | a 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.
errCode | the error code |
repType | the type of the component which raises the error report |
repServSubType | the sub type of the component which raises the error report |
repDiscriminant | the discriminant of the component which raises the error report |
Definition at line 37 of file CrPsRepErr.c.