The AlarmData type exposes the following members.

Constructors

  NameDescription
Public methodAlarmData
Default constructor

Methods

  NameDescription
Public methodStatic memberComposeLink
Composes a link with command definition
Public methodEquals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodEquals(array<Byte>[]()[][])
Checks if this AlarmData has the same eventId of the parameter
Public methodGetCalculatedStringValue
Retrieves the raw value (with resolved aliases and translations) for a specific field key, converted to string
Public methodGetCalculatedValue
Retrieves the calculated value (with resolved aliases and translations) for a specific field key
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIndex
Returns the index of the item
Protected methodGetPropertyName``1 (Inherited from BindableObject.)
Public methodGetRawStringValue
Retrieves the raw value (coming directly from the server) for a specific field key, converted to string
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsCondition
Checks if the AlarmData is a condition
Public methodStatic memberIsDisplayBinding
Checks if the display value contains a binding
Public methodIsVisible
Checks if this AlarmData should be shown
Public methodMarkEmpty
All the values are set to null
Protected methodOnPropertyChanged(String) (Inherited from BindableObject.)
Protected methodOnPropertyChanged``1(Expression<(Of <<'(Func<(Of <<'(UMP>)>>)>)>>)) (Inherited from BindableObject.)
Protected methodSetAndNotify``1(UMP%, UMP, Expression<(Of <<'(Func<(Of <<'(UMP>)>>)>)>>)) (Inherited from BindableObject.)
Protected methodSetAndNotify``1(UMP%, UMP, String) (Inherited from BindableObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodStatic memberTryParseLink
Parses a link which contains a command
Public methodUpdateSubscriptionProperties
Updates time zone properties.

Properties

  NameDescription
Public propertyAcknowledgeActiveTime
Actual time and date when the alarm became active Used for acknowledge because the ActiveTime gets reset with timezones
Public propertyActiveTime
Specifies the time and date when the alarm became active
Public propertyAlarmConfirmationActiveTime
The type of the event
Public propertyAlarmConfirmationProgress
Stores the alarm confirmation progress
Public propertyAlarmState
The state of the alarm
Public propertyAlarmType
The type of the event
Public propertyAliasedMessage
The Aliased Message of the alarm
Public propertyAliasedSource
The Aliased Source of the alarm
Public propertyArea
Shows the area of the alarm
Public propertyBackground
The background of the visual object that will represent the AwxElement
Public propertyBeepSpeed
The speed used for beeping
Public propertyBlinkingBackground
The Blinking background of the visual object that will represent the AwxElement
Public propertyBlinkingFontFamily
Specifies the FontFamily of the font for the visual object that will represent the AwxElement
Public propertyBlinkingFontSize
Specifies the size of the font for the visual object that will represent the AwxElement
Public propertyBlinkingFontStyle
Specifies the FontStyle of the font for the visual object that will represent the AwxElement
Public propertyBlinkingFontWeight
Specifies the FontWeight of the font for the visual object that will represent the AwxElement
Public propertyBlinkingForeground
The Blinking foreground of the visual object that will represent the AwxElement
Public propertyBlinkSpeed
The speed used for blinking
Public propertyCategory
The category of the alarm (e.g. Digital, Limit, ROC, Deviation)
Public propertyDisplayValueBindings
We can specify a display value (eventually a binding to another value) for each field in the ItemsKey
Public propertyEncodedEventID
The EventID encoded as a string
Public propertyEventClass
The class of the alarm data (Simple or Condition). Used by CLASSIC OPC AE in order to recognize an alarm or an event
Public propertyEventID
The EventID is used to acknowledge the alarm. It's the unique identifier of the EVENT.
Public propertyFontFamily
Specifies the FontFamily of the font for the visual object that will represent the AwxElement
Public propertyFontSize
Specifies the size of the font for the visual object that will represent the AwxElement
Public propertyFontStyle
Specifies the FontStyle of the font for the visual object that will represent the AwxElement
Public propertyFontWeight
Specifies the FontWeight of the font for the visual object that will represent the AwxElement
Public propertyForeground
The foreground of the visual object that will represent the AwxElement
Public propertyIsConfirmation
Stores if this alarm is has the alarm confirmation feature enabled
Public propertyIsEmpty
Specifies if the alarm contains empty values (this happens when the alarm is not deleted immediately, but it needs to be cleared)
Public propertyIsTimeZoneEnabled
Set true = if (String.IsNullOrEmpty(TimeZoneID) and DateTimeHelper.IsTimeZoneIdValid(TimeZoneID))
Public propertyIsVisual
Stores if this alarm is actually displayed in the GUI
Public propertyIsWeighted
Stores if this alarm is has the weighted feature enabled
Public propertyItemArray
The array of values that were sent together with the notification
Public propertyItemKeys
The list of the keys used to identify the values in the ItemArray. Each item in the item array has its own key in the ItemKeys.
Public propertyMessage
The Message of the alarm
Public propertyNode
The SourceName is used to aggregate different events together
Public propertyNotBlinkingBackground
The background of the visual object that will represent the AwxElement
Public propertyNotBlinkingFontFamily
Specifies the FontFamily of the font for the visual object that will represent the AwxElement
Public propertyNotBlinkingFontSize
Specifies the size of the font for the visual object that will represent the AwxElement
Public propertyNotBlinkingFontStyle
Specifies the FontStyle of the font for the visual object that will represent the AwxElement
Public propertyNotBlinkingFontWeight
Specifies the FontWeight of the font for the visual object that will represent the AwxElement
Public propertyNotBlinkingForeground
The foreground of the visual object that will represent the AwxElement
Public propertyOriginalItemArray
The array of ORIGINAL values that were sent together with the notification
Public propertyRawCategory
The raw category value of the alarm as defined by the sever (e.g. Digital, Limit, ROC, Deviation)
Public propertySeverity
The Severity of the event
Public propertySource
The Tag name of the alarm
Public propertyStyleKey
Specifies the key that identifies the style associated to this Alarm Data
Public propertySubCondition
The SubCondition of the alarm (e.g. LO, HI, HIHI, LOLO..)
Public propertyTime
Specifies the Time when the alarm was generated on the server
Public propertyTimeZoneID
Time Zone Id for offset.
Public propertyValues
The array of (translated) values that should be used for data binding

Events

  NameDescription
Public eventPropertyChanged (Inherited from BindableObject.)

See Also