Class for Alarm operation.

Namespace: T.Modules.Alarm
Assembly: T.Modules (in T.Modules.dll)

Public Class ModuleAlarm 
Inherits ListObj
This language is not supported or no code example is available.
public class ModuleAlarm : ListObj
This language is not supported or no code example is available.
Name Description
Public constructor ModuleAlarm(RunObj, int) Construct an instance of this class
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 ActiveUnAckCount Get the number of Unacknowledge Alarms.
Public property Area Provides access to AlarmArea objects.
Public property AuditTrail Provides access to AlarmAuditTrail objects.
Public property BeepState Flag to indicate the beep state. This flag can be changed to disable the beep.
Public property BeepValue Flag to indicate the beep value.
Public property CurrentShift Current alarm limit shift that select the limit that will be used.
Public property EnableLimitsByShift ReadOnly flag to indicate the alarm limits shift execution.
Public property ErrorCount Error count when storing alarm item
Public property Group Provides access to AlarmGroup objects.
Public property IgnoreAlarmsDuringTimeDeadband If true then any alarm is ignored during initial disable time.
Public property InitialDisableTime The alarm module execution will be started after this time.
Public property InitializationMessage Initialization message.
Public property IsAlarmEventsInOverflow ReadOnly flag to indicate alarm or event overflow.
Public property IsNotifySync Flag indicating whether notification method will be called immediately when alarm occurs.
Public property IsSecondaryActive Flag the indicate the secondary alarm database status.
Public property IsStarted Flag indicating whether Alarm module was full started
Public property Item(Int32) Get runtime object based in an ID (T.Kernel.Core.ListObj).
Public property Item(String) Get runtime object based in an ID (inherited from ListObj).
Public property Item Provides access to AlarmItem objects.
Public property LastHistorianTimestampTicks Timespamp tick of last alarm item stored.
Public property LastHistoricID ID of last alarm item stored.
Public property LastPackExecutedErrorMessage ReadOnly string to indicate last history pack error message.
Public property LastPackExecutedTimeStamp ReadOnly flag to indicate last history pack operation timestamp.
Public property LastStoredErrorMessage Last error message when an alarm item was stored.
Public property LastStoredTimeStamp Timestamp when last alarm item was stored.
Public property LastTickAdded Timespamp tick of last alarm item store operation.
Public property LifeTime Number of days that history will be available to access.
Public property LogUserFullName Flag to indicate that User FullName option will be used to save current name.
Public property OpenStatusMessage Open status message
Public property PackCompleted ReadOnly flag to indicate the history pack operation completed.
Public property PackExecute Flag to force a history pack database. A toggle on this flag to execute the operation.
Public property PriorityItem Return the highest priority Alarm Item of an AlarmGroup.
Public property QueryActive Current datatable with active alarm objects.
Public property Redundancy Provides access to Alarm Redundancy object.
Public property Restart Flag to force an alarm module restart. A toggle on this flag to execute the operation.
Public property StartCounter Counter while starting module
Public property StoreAndForward Provides access to StoreAndForward object.
Public property SuccessCount Success count when storing alarm item
Public property TotalCount Get the number of Active Alarms.
Public property UnAckCount Get the number of Unacknowledge Alarms.
Public property UpdateValueOnNormOrAck Flag indicating whether Value should be updated when saving alarm in database (normalize or ack). Default is true
Public property UserName Current username that is related with alarm item.
Top
Name Description
Public method AckAllWithComments(string) Ack all alarm items with comment
Public method AckAllWithComments(string, string, string) Ack all alarm items with comment
Public method GetItemList(string) Get list of alarm items related to tag
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
Public method SaveToTextFile(DateTime, DateTime, string, string, char, bool, int, CultureInfo) Save alarms to text file
Public method VerifyDBConnection() Verify and reopen Alarm database
Top

.NET Framework

Supported in: 4.6.2, 4.7