Definition and raise of errors in source code

Direct call of error

An error can be set everywhere in the code. This error with the error-text and additional metadata can be defined directly in the function which sets the error, or it can be defined elswhere before as globar error. If the error should not be define before the SetError function is used to raise the error.

Here an Example of a simple SetError call is shown:

SetError(SampleErrorID_1,                                   // Error-ID
        DEVELOPER_RESET | PROFESSIONAL_RESET | USER_RESET,      // Flags
        TestErrorReaction,                                      // Function to be called on first time setting the error
        NoOnErrorResetReaction,                                 // Function to be called on resetting the error
        "Test Error 1",                                         // Short Description
        "DOC_D Ein Fehler am digitalen Ausgang wurde detektiert. Mögliche Ursachen:<br>-Überlast<br>-Kursschluss zur Masse<br>-Kursschluss zur 24V Versorgung<br>-Übertemperatur"\
        "DOC_E A Fault at the digital Output was detected. Possible reasons:<br>-Overload<br>-Short to ground<br>-Short positive supply<br>-Thermal overload");

In this example the error with the predefined identifier SampleErrorID_1 is raised. The identifier should be unique in project, but it is not neccessary for the error-system to work. Due to this the uniqueness is not checked anywhere. It is a good practice to define all error-identifier in a central file Error_ID_Device.h.

This error is resettable from users of the group user, professional and developer. This field is an or-concatenated list of the flags defined in the enum ERROR_FLAGS.

The error reaction which is called after raising this error is TestErrorReaction, which must be defined elswhere (see Page Actions on Error set and reset for details). On error reset no action is performed.

Text and description are displayed in the error-log. The helptext is shown on pc after pressing F1. It can contain several lines in german and english. See page Help-texts in Errors for details.

The german helpwindow:

English version:

In this example the headerfile must be included and the identifier defined (normally done in Error_ID_Device.h):

#include "lib/Error/Error.h"
#define SampleErrorID_1     50001

Call of a predefined error

If the error is raised from several codelines, the error can be defined on a central place in code. The definition is shown in the following example:

DefineError(SampleErrorID_2,                                 // Error-ID
    DEVELOPER_RESET | PROFESSIONAL_RESET | USER_RESET | PLC_RESET,      // Flags
    NoOnErrorReaction,                                                  // Function to be called on first time setting the error
    NoOnErrorResetReaction,                                             // Function to be called on resetting the error
    "Test Error 2",                                                     // Short Description
    "DOC_D Testfehler 2"\
    "DOC_E Test Error 2");

The fileds of the definition are the same than the direct call.

This error can be raised by this simple line:

SetErrorId(SampleErrorID_2);

If the call should be done in a different file than the declaration, it must be visible in the calling file. This can be done with a declaration in the header file:

extern DeclareError(SampleErrorID_2);