Type: BCS.Sym3.Operator.Runtime.IAlarmClientService

Alarm client service Remarks: Available in Operator only

Properties

Disabled

  • Description: Get a list of disabled alarms
  • Type: List`1
  • Access: Read

IsConnected

  • Description: Returns true if client is connected to alarm server
  • Type: Boolean
  • Access: Read

RuntimeAlarms

  • Description: Returns list of alarm instances
  • Type: IObservableCollectionEx`1
  • Access: Read

Methods

Acknowledge(System.Collections.Generic.List{BCS.Sym3.Operator.Runtime.IRuntimeAlarm})

Acknowledge a list of alarm

  • Parameters:
    • alarms:

Acknowledge(System.Int32)

Acknowledge alarm by its id (integer)

  • Parameters:
    • id: id of alarm to acknowledge

Acknowledge(System.Int32[])

Acknowledge a list of alarm

  • Parameters:
    • arrayIds: array of alarm id

AcknowledgeAll

Acknowledge all alarms

Connect

Connects to alarm server

Disable(System.Collections.Generic.List{BCS.Sym3.Operator.Runtime.IRuntimeAlarm})

Disable a list of alarm

  • Parameters:
    • alarms:

Disconnect

Disconnect alarm server

Enable(System.Boolean,BCS.Sym3.IAlarmDefinition)

Enable or Disable an alarm

  • Parameters:
    • enabled: true to enable; false to disable
    • alarm: The alarm to enable or disable

Enable(System.Boolean,System.Collections.ICollection)

Enable or Disabel a collection of alarm

  • Parameters:
    • enabled: true to enable; false to disable
    • alarms: The collection of alarm to enable or disable

OpenUDPEditor(System.Collections.Generic.List{BCS.Sym3.Operator.Runtime.IRuntimeAlarm},System.Boolean,System.UInt32,System.UInt32)

Pops up the user defined property editor for selected alarm instances

  • Parameters:
    • alarms: selected alarms to edit
    • atMousePosition: if true the form will pops up at mouse position
    • x: if atMousePosition=false, the form will popups at position x, y
    • y: if atMousePosition=false, the form will popups at position x, y
  • Example:
This example shows you how to use this method:


            Client.Authentication.DisplayLoginDialog(false, 200, 100);

RefreshAlarms

Force to refresh all alarms

ShowDisabled

Show Disabled alarms