ModuleAlarm Class

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.

Constructors

---

	Name	Description
	ModuleAlarm(RunObj, int)	Construct an instance of this class

Top

Properties

---

	Name	Description
	AckAll	Acknowledge all alarm items that belong to this group.
	AckAllWithCommentsInternal	String comment used when AckAll with comment operation is executed.
	ActiveUnAckCount	Get the number of Unacknowledge Alarms.
	Area	Provides access to AlarmArea objects.
	AuditTrail	Provides access to AlarmAuditTrail objects.
	BeepState	Flag to indicate the beep state. This flag can be changed to disable the beep.
	BeepValue	Flag to indicate the beep value.
	CurrentShift	Current alarm limit shift that select the limit that will be used.
	EnableLimitsByShift	ReadOnly flag to indicate the alarm limits shift execution.
	ErrorCount	Error count when storing alarm item
	Group	Provides access to AlarmGroup objects.
	IgnoreAlarmsDuringTimeDeadband	If true then any alarm is ignored during initial disable time.
	InitialDisableTime	The alarm module execution will be started after this time.
	InitializationMessage	Initialization message.
	IsAlarmEventsInOverflow	ReadOnly flag to indicate alarm or event overflow.
	IsNotifySync	Flag indicating whether notification method will be called immediately when alarm occurs.
	IsSecondaryActive	Flag the indicate the secondary alarm database status.
	IsStarted	Flag indicating whether Alarm module was full started
	Item(Int32)	Get runtime object based in an ID (T.Kernel.Core.ListObj).
	Item(String)	Get runtime object based in an ID (inherited from ListObj).
	Item	Provides access to AlarmItem objects.
	LastHistorianTimestampTicks	Timespamp tick of last alarm item stored.
	LastHistoricID	ID of last alarm item stored.
	LastPackExecutedErrorMessage	ReadOnly string to indicate last history pack error message.
	LastPackExecutedTimeStamp	ReadOnly flag to indicate last history pack operation timestamp.
	LastStoredErrorMessage	Last error message when an alarm item was stored.
	LastStoredTimeStamp	Timestamp when last alarm item was stored.
	LastTickAdded	Timespamp tick of last alarm item store operation.
	LifeTime	Number of days that history will be available to access.
	LogUserFullName	Flag to indicate that User FullName option will be used to save current name.
	OpenStatusMessage	Open status message
	PackCompleted	ReadOnly flag to indicate the history pack operation completed.
	PackExecute	Flag to force a history pack database. A toggle on this flag to execute the operation.
	PriorityItem	Return the highest priority Alarm Item of an AlarmGroup.
	QueryActive	Current datatable with active alarm objects.
	Redundancy	Provides access to Alarm Redundancy object.
	Restart	Flag to force an alarm module restart. A toggle on this flag to execute the operation.
	StartCounter	Counter while starting module
	StoreAndForward	Provides access to StoreAndForward object.
	SuccessCount	Success count when storing alarm item
	TotalCount	Get the number of Active Alarms.
	UnAckCount	Get the number of Unacknowledge Alarms.
	UpdateValueOnNormOrAck	Flag indicating whether Value should be updated when saving alarm in database (normalize or ack). Default is true
	UserName	Current username that is related with alarm item.

Top

Methods

---

	Name	Description
	AckAllWithComments(string)	Ack all alarm items with comment
	AckAllWithComments(string, string, string)	Ack all alarm items with comment
	GetItemList(string)	Get list of alarm items related to tag
	SaveToTextFile(DateTime, DateTime, string, char, bool, int, CultureInfo)	Save alarms to text file
	SaveToTextFile(DateTime, DateTime)	Save alarms to text file
	SaveToTextFile(string, string, string, char, bool, int, CultureInfo)	Save alarms to text file
	SaveToTextFile(string, string)	Save alarms to text file
	SaveToTextFile(DateTime, DateTime, string, string, char, bool, int, CultureInfo)	Save alarms to text file
	VerifyDBConnection()	Verify and reopen Alarm database

Top