The AlarmSubscription type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AlarmSubscription |
Initializes a new instance of the AlarmSubscription class.
|
Methods
| Name | Description | |
|---|---|---|
 | CreateDefaultHASubscription |
Creates a default AlarmSubscription instance for an entire Hyper Alarm Server on the local node.
|
| CreateDefaultSubscription |
Creates a default AlarmSubscription instance for an entire Server on the local node.
|
| CreateEventFilter |
Returns the WhereClause of a NoncontextEventFilter, that can be used on the server side.
|
| CreateEventSubscription |
Creates a default AlarmSubscription instance for an entire GenEvent Server on the local node.
|
| CreateNoncontextEventFilter(String) |
Creates a filter that has no dependencies on the event point. This method is usually used by Historical Subscriptions
where points share the same WHERE clause and there are no custom attributes
|
| CreateNoncontextEventFilter(EventPoint, String) |
Creates a filter of properties exposed by the event point
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetAliases |
Returns the aliases uses by the virtual fields
|
| GetAutoKeys |
Given a FieldGroupMap return automatically the custom keys associated with each group
|
| GetAutoMapping |
Gets an automatic mapping of the fields. The fields with the same name and the same type are aggregated together
|
| GetCategoriesAsync |
Given an alarm tag retrieves the categories exposed by the alarm server associated with the tag
|
| GetExpressionKeys |
Return a list of the expression keys used in the subscription, one for each field group.
|
| GetFieldsMapping |
Maps the index of the field in the subscription with its position in the mapped list
|
| GetGroupKeys |
Return a list of the keys used in the subscription, one for each field group.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetKey |
Returns the Key of the AlarmSubscription.
|
| GetMappingFromGroupKey |
Given a Group Key returns the index of the group in the FieldGroupMap |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetAutoMapping |
Automatically sets the FieldGroupMap coming from GetAutoMapping()()()() method
|
| SetFields |
Replaces the Fields collection with a new set of EventField. It will send just ONE overall event
|
| SetMapping(FieldGroupMap) |
Sets the mapping for the columns
|
| SetMapping(FieldGroupMap, FieldGroupKeys) |
Sets the mapping for the columns
|
| ToString |
Returns a String that represents the current Object.
(Overrides Object..::..ToString()()()().) |
Properties
| Name | Description | |
|---|---|---|
 | Fields |
A collection of the selected EventField |
| HistoryTimeRange | Obsolete.
FOR INTERNAL USE NOT FOR CUSTOMERS
Gets or sets a date/time interval to limit the history of requested event points
|
| IsHistorical |
Specifies if the subscription is historical or real time
|
| IsReadOnly |
Specifies if the subscription is read only or not
|
| Map |
Defines the columns Map
|
| Name |
The name of this subscription
|
| NewEventsPosition |
Defines where the new incoming events should be put in the grid
|
| Points |
Collection of subscribed EventPoint |
| TimeRange |
Gets or sets a date/time interval to limit the history of requested event points
|
| TimeZone |
Defines the Time Zone tag for this subscription>
|
Events
| Name | Description | |
|---|---|---|
 | SubscriptionChanged |
Event fired when AlarmSubscription is modified.
|
