Class for Alarm operation.

The following tables list the members exposed by the ModuleAlarm type.

Constructors
Name Description
Public constructor ModuleAlarm Construct an instance of this class
Top
Properties
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 ArrayIndexes (inherited from RunObj).
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 Count (inherited from ListObj).
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 ID (inherited from RunObj).
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 IsPacking
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 (Overloaded) 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 ObjServer (inherited from RunObj).
Public property ObjType (inherited from RunObj).
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 Parent (inherited from RunObj).
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 Root (inherited from RunObj).
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 SyncRoot (inherited from ListObj).
Public property TModule (inherited from RunObj).
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
Methods
Name Description
Public method AckAllWithComments (Overloaded) Ack all alarm items with comment
Public method ClearCacheNames (inherited from ListObj).
Public method Equals (Overloaded) (inherited from Object).
Public method GetEnumerator (inherited from ListObj).
Public method GetHashCode (inherited from Object).
Public method GetID (inherited from ListObj).
Public method GetItemList Get list of alarm items related to tag
Public method GetName (Overloaded) (inherited from ListObj).
Public method GetObj (Overloaded) (inherited from ListObj).
Public method GetObjAsObject (inherited from ListObj).
Public method GetObjRef (inherited from RunObj).
Public method GetType (inherited from Object).
Public method IsInUse (inherited from ListObj).
Public method OnContinue (inherited from RunObj).
Public method OnPause (inherited from RunObj).
Public method OnStart (inherited from RunObj).
Public method OnStop (inherited from RunObj).
Public method PreloadRunObj (inherited from ListObj).
Public method Static ReferenceEquals (inherited from Object).
Public method SaveToTextFile (Overloaded) Save alarms to text file
Public method StartPreloadRunObjs (Overloaded) (inherited from ListObj).
Public method ToString (inherited from RunObj).
Public method VerifyDBConnection Verify and reopen Alarm database
Top
Extension Methods
Name Description
Public extension method ApplyCast (Overloaded) (Defined by GenericEnumerableHelper).
Public extension method ApplyCount (Defined by GenericEnumerableHelper).
Public extension method ApplySelect (Overloaded) (Defined by GenericEnumerableHelper).
Public extension method ApplyWhere (Defined by GenericEnumerableHelper).
Public extension method ApplyWhereNotNull (Defined by GenericEnumerableHelper).
Public extension method AsParallel (Defined by ParallelEnumerable).
Public extension method AsQueryable (Defined by Queryable).
Public extension method Cast (Defined by Enumerable).
Public extension method ConvertAll (Defined by IEnumerableExtensions).
Public extension method GetParentViewModel (Defined by POCOViewModelExtensions).
Public extension method GetRequiredService (Overloaded) (Defined by POCOViewModelExtensions).
Public extension method GetService (Overloaded) (Defined by POCOViewModelExtensions).
Public extension method IsInDesignMode (Defined by POCOViewModelExtensions).
Public extension method OfType (Defined by Enumerable).
Public extension method RaisePropertiesChanged (Defined by POCOViewModelExtensions).
Top
See Also