AlarmGroup Class

Class for AlarmGroup operation.
Public Class AlarmGroup
This language is not supported or no code example is available.
public class AlarmGroup
This language is not supported or no code example is available.
Name Description
Public constructor AlarmGroup(RunObj, int) Construct the instance
Top
Name Description
Public property AckAll Acknowledge all alarm items that belong to this group.
Public property AckAllWithCommentsInternal String comment used when AckAll with comment operation is executed.
Public property AckRequired Get the defined required operator Acknowledgment.
Public property AckTimeout Timout to reactivate the alarm item after an acknologed without normalize action.
Public property ActiveTimeDeadband Time deadband to alarm to be generated
Public property ActiveUnAckCount Get the number of Unacknowledge Alarms.
Public property AutoAckTime Time to generate an automatic acknowledge
Public property Category String with the configured category of Alarm Group
Public property Colors Represents the foreground and background colors for each Alarm state.
Public property CustomEvaluation Flag indicating whether alarms are generated outside Alarm module.
Public property Description AlarmGroup Description configured in EditAlarmsGroups.
Public property Disable Disable/Enable an Alarm Group.
Public property DisableLog Flag indicating whether log events are disabled.
Public property Id Gets the ID of an Alarm Group.
Public property LastAlarmItemNotified String with name of last alarm item notified.
Public property Level String with the configured levels of Alarm Group
Public property LogEvents Get the type of Historian archiving on Alarm events.
Public property NotificationMethod Property to indicate the notification method.
Public property PriorityItem Return the highest priority Alarm Item of an AlarmGroup.
Public property Show Gets a configured value to display/not display an Alarm.
Public property Sound Property to describe if the Alarm Group Sound is Enabled or Disabled.
Public property Suspend Suspend an Alarm Group.
Public property TotalCount Get the number of Active Alarms.
Public property UnAckCount Get the number of Unacknowledge Alarms.
Public property UserName UserName used with alarm item.
Top
Methods
 
Name Description
Public method AckAllWithComments(string) Ack all alarm items with comment
Public method AckAllWithCommentsAsync(string, string, string) Ack all alarm items with comment
Public method SaveToTextFile(DateTime, DateTime, string, char, bool, int, CultureInfo) Save alarms to text file
Public method SaveToTextFile(DateTime, DateTime) Save alarms to text file
Public method SaveToTextFile(string, string, string, char, bool, int, CultureInfo) Save alarms to text file
Public method SaveToTextFile(string, string) Save alarms to text file
Top
T.Modules.Alarm.AlarmGroup

.NET Framework

Supported in: 4.6.2, 4.7

In this article

Definition