Skip to main content

GlobalMessageService

Short summary

This class takes care of managing active messages and alarms. It will link itself to all other message services so they can forward events.

AccessAbstractFinalExtendsImplements
NoYesCNM_MessageInterfaces.AbstractMessageServiceProviderCNM_MessageInterfaces.IMessageService

UML Diagram

Parameters

none

Properties

className

Type: CNM_AbstractObject.ClassName

This abstract property returns the class name of the concrete object,

hasActiveAlarm

Type: bool

Methods

attatchDialogManager

  • Parameters:
    • manager (IDialogManager): the interface of the manager that should be injected
  • Return type: VOID

This method can be used to inject custom dialog manager.

clear

This method removes a given event from the active events queue.

handle

This methods adds a given event to the list of active events.

run

  • Return type: VOID

This method updates and manages all the active events. It checks if an event is pending (needs to be confirmed by the operator) and confirmed.

Code

Declaration

FUNCTION_BLOCK FINAL GlobalMessageService EXTENDS CNM_MessageInterfaces.AbstractMessageServiceProvider IMPLEMENTS CNM_MessageInterfaces.IMessageService
VAR
activeAlarm :BOOL;
activeAlarmList :CNM_Collections.LinkedList();
clearAlarmList :CNM_Collections.LinkedList();
activeAlarmsIterator :CNM_Collections.ForwardLinkedListIterator(activeAlarmList);
clearedAlarmsIterator :CNM_Collections.ForwardLinkedListIterator(clearAlarmList);
linker :GlobalMessageServiceLinker(THIS^);
dialogManager :IDialogManager;
END_VAR