CORDET Framework - C2 Implementation
|
Interface for reporting an error detected by a framework component. More...
Go to the source code of this file.
Functions | |
void | CrFwRepErr (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId) |
Report an error which has no parameters attached to it. More... | |
void | CrFwRepErrDestSrc (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwDestSrc_t destSrc) |
Report an error which has one single parameter attached to it representing a command or report destination or source. More... | |
void | CrFwRepErrGroup (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwGroup_t group) |
Report an error which has one single parameter attached to it representing a command or report group. More... | |
void | CrFwRepErrSeqCnt (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwSeqCnt_t expSeqCnt, CrFwSeqCnt_t actSeqCnt, CrFwPckt_t pckt) |
Report an error which has two parameters attached to it representing expected and actual sequence counter values. More... | |
void | CrFwRepErrInstanceIdAndOutcome (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwInstanceId_t secondaryInstanceId, CrFwOutcome_t outcome) |
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 the outcome field of a component's data. More... | |
void | CrFwRepErrInstanceIdAndDest (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwInstanceId_t secondaryInstanceId, CrFwDestSrc_t dest, CrFwPckt_t pckt) |
Report an error which has three parameters attached to it representing the instance identifier of a component other than the originator of the error report (the secondary instance identifier), a command or report destination and a command or report packet. More... | |
void | CrFwRepErrPckt (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwPckt_t pckt) |
Report an error which has one parameter attached to it representing a command or report packet. More... | |
void | CrFwRepErrRep (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, FwSmDesc_t rep) |
Report an error which has one parameter attached to it representing an report component. More... | |
void | CrFwRepErrCmd (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, FwSmDesc_t cmd) |
Report an error which has one parameter attached to it representing a command component. More... | |
void | CrFwRepErrKind (CrFwRepErrCode_t errCode, CrFwTypeId_t typeId, CrFwInstanceId_t instanceId, CrFwServType_t servType, CrFwServSubType_t servSubType, CrFwDiscriminant_t disc) |
Report an error which has three parameters attached to it representing the kind of a report or command as given by the triplet [type, sub-type, discriminant]. More... | |
Interface for reporting an error detected by a framework component.
When a framework 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. Not all functions defined in this interface are used by the CORDET Framework. Some are intended for use by application components.
The range of error codes is defined in type CrFwRepErrCode_t
. Note that this is a configurable type that users are expected to extend with their own error codes.
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.
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 CrFwRepErr.h.
void CrFwRepErr | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId | ||
) |
Report an error which has no parameters attached to it.
This function generate an error report without error 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 |
Definition at line 89 of file CrFwRepErr.c.
void CrFwRepErrCmd | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
FwSmDesc_t | cmd | ||
) |
Report an error which has one parameter attached to it representing a command component.
This function generate an error report with one parameter.
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 |
cmd | a component holding a command |
Definition at line 232 of file CrFwRepErr.c.
void CrFwRepErrDestSrc | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwDestSrc_t | destSrc | ||
) |
Report an error which has one single parameter attached to it representing a command or report destination or source.
This function generate an error report with one parameter.
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 |
destSrc | the invalid destination or source |
Definition at line 102 of file CrFwRepErr.c.
void CrFwRepErrGroup | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwGroup_t | group | ||
) |
Report an error which has one single parameter attached to it representing a command or report group.
This function generate an error report with one parameter.
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 |
group | the invalid group |
Definition at line 136 of file CrFwRepErr.c.
void CrFwRepErrInstanceIdAndDest | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwInstanceId_t | secondaryInstanceId, | ||
CrFwDestSrc_t | dest, | ||
CrFwPckt_t | pckt | ||
) |
Report an error which has three parameters attached to it representing the instance identifier of a component other than the originator of the error report (the secondary instance identifier), a command or report destination and a command or report packet.
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 |
pckt | a packet holding a command or report (this is a pointer which is only guaranteed valid during the function execution) |
Definition at line 117 of file CrFwRepErr.c.
void CrFwRepErrInstanceIdAndOutcome | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwInstanceId_t | secondaryInstanceId, | ||
CrFwOutcome_t | outcome | ||
) |
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 the outcome field of a component's data.
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 |
outcome | outcome field of a component's data |
Definition at line 183 of file CrFwRepErr.c.
void CrFwRepErrKind | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwServType_t | servType, | ||
CrFwServSubType_t | servSubType, | ||
CrFwDiscriminant_t | disc | ||
) |
Report an error which has three parameters attached to it representing the kind of a report or command as given by the triplet [type, sub-type, discriminant].
This function generate an error report with three 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 |
servType | the report or command type |
servSubType | the report or command sub-type |
disc | the report or command discriminant |
Definition at line 249 of file CrFwRepErr.c.
void CrFwRepErrPckt | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwPckt_t | pckt | ||
) |
Report an error which has one parameter attached to it representing a command or report packet.
This function generate an error report with one parameter.
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 |
pckt | a packet holding a command or report (this is a pointer which is only guaranteed valid during the function execution) |
Definition at line 201 of file CrFwRepErr.c.
void CrFwRepErrRep | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
FwSmDesc_t | rep | ||
) |
Report an error which has one parameter attached to it representing an report component.
This function generate an error report with one parameter.
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 |
rep | a component holding a report |
Definition at line 215 of file CrFwRepErr.c.
void CrFwRepErrSeqCnt | ( | CrFwRepErrCode_t | errCode, |
CrFwTypeId_t | typeId, | ||
CrFwInstanceId_t | instanceId, | ||
CrFwSeqCnt_t | expSeqCnt, | ||
CrFwSeqCnt_t | actSeqCnt, | ||
CrFwPckt_t | pckt | ||
) |
Report an error which has two parameters attached to it representing expected and actual sequence counter values.
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 |
expSeqCnt | the expected sequence counter |
actSeqCnt | the actual sequence counter |
pckt | a packet holding a command or report (this is a pointer which is only guaranteed valid during the function execution) |
Definition at line 151 of file CrFwRepErr.c.