IF_MiniDiagSource - General Information

Overview

Type:

Interface

Available as of:

V2.0.0.0

Versions:

Current version

Description

This interface must be implemented from every MiniDiagSource so that it can be connected to the MiniDiagTreeDiagSource.

Every EDESIGN module requires a corresponding module-specific instance of an IF_MiniDiag­Source for MiniDiagTreeDiagSource. This instance manages the reading out of the default interface and the module-specific interface from the respective EDESIGN module and transfers the data to the MiniDiagTreeDiagSource.

In order to represent the hierarchy of the module in accordance with the arrangement in the EDESIGN structure editor, the instances of the MiniDiagSources can be lined up as a hierarchical tree. The MiniDiagSource instances are dynamically generated by EDESIGN. IF_MiniDiagSource is implemented by FB_BaseMiniDiagSource and encapsulates all required basic functions to output StandardItf data. FB_BaseGroupModuleMiniDiagSource enhances this basic functionality further with the option of an arrangement in the form of a hierarchical tree. All module-specific MiniDiagSource implementations are derived from one of these two basic classes.

The XML output of all the MiniDiagSources is (must be!) issued via a combined TreeWriter instance. To help prevent multiple writing access and ensure the creation of a valid XML output, the output of MiniDiagSources is coordinated with each other. This is carried out via a polling to give the MiniDiag concept more flexibility for the output of data of different sizes that are not time-critical and to distribute these over several real-time cycles without impairing other critical routines.

xCompleted signalizes the superordinated MiniDiagSource module whether the XML output that was started defined by WriteDiagDataToFile has been completed. The call-up of WriteDiagData­ToFile as well as the prompt of xCompleted are performed by the hierarchically superordinated MiniDiagSource module.

Methods

Name

Description

Reset

Prepares all the internal states for the data output. Required before calling up WriteDiagDataToFile.

WriteDiagDataToFile

Output the interface data.

Properties

Name

Data type

Accessing

Description

udiLevelCounter

UDINT

Read/Write

Hierarchy level of the submodule in the EDESIGN module tree

xCompleted

BOOL

Read

Is TRUE if the XML output of the module and all submodules has been completed. Now the calling module can complete the XML branching that was opened before the call-up.