ModuleAlarm Class

Namespace: T.Modules.Alarm
Assembly: T.Kernel.Tags (in T.Kernel.Tags.dll)
Class for Alarm operation.
VB
C#
F#
C++
JScript
Copy 
Public Class ModuleAlarm
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
public class ModuleAlarm
This language is not supported or no code example is available.
Constructors
 
Name Description
Public constructor ModuleAlarm(RunObj, int) Construct an instance of this class
Top
Properties
 
Name Description
Public property AckAlarmItem Internal AckAlarmItem
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 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 DisableSaveToDatabase If true then alarms will not be stored in Dataset DB
Public property ErrorCount Error count when storing alarm item
Public property GlobalSettings Provides access to GlobalSettings objects.
Public property Group Provides access to AlarmGroup objects.
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 Item Provides access to AlarmItem objects.
Public property LastErrorMessage Gets the last error message for this Module
Public property LastHistorianTimestampTicks Timespamp tick of last alarm item stored.
Public property LastHistoricID ID of last alarm item stored.
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 PendingEvents Pending events
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 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 UserName Current username that is related 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 ForceAcknowledge(string[], DateTime[], string[], string[], string[], int[], string[], bool) Force acknowledge of Alarm Item
Public method GetItemList(string) Get list of alarm items related to tag
Public method GetTotalCount(string) Retrieves the total count of alarms based on the provided filter. <param name="filter">The filter string to apply to the alarms.</param> <returns>The total count of alarms that match the filter. Returns 0 if no alarms are found or if an error occurs.</returns>
Public method SaveToTextFile(DateTime, DateTime) Obsolete. Save alarms to text file
Public method SaveToTextFile(DateTime, DateTime, string, char, bool, int, CultureInfo) Obsolete. Save alarms to text file
Public method SaveToTextFile(string, string) Obsolete. Save alarms to text file
Public method SaveToTextFile(string, string, string, char, bool, int, CultureInfo) Obsolete. Save alarms to text file
Public method SaveToTextFileAsync(DateTime, DateTime, string, char, bool, int, CultureInfo) Save alarms to text file
Public method SaveToTextFileAsync(DateTime, DateTime) Save alarms to text file
Public method SaveToTextFileAsync(string, string, string, char, bool, int, CultureInfo) Save alarms to text file
Public method SaveToTextFileAsync(string, string) Save alarms to text file
Public method SaveToTextFileAsync(DateTime, DateTime, string, string, char, bool, int, CultureInfo) Save alarms to text file
Public method VerifyDBConnection() Verify and reopen Alarm database
Top
Inheritance Hierarchy
 
T.Modules.Alarm.ModuleAlarm
Applies to
 

.NET Framework

Supported in: 4.8
See Also
 

In this article

Definition