Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

OpcSubscriptionSetup Class

Namespace: Opc.UaFx.Client
Assemblies: Opc.UaFx.Advanced.dll

Defines a set of properties which can be used to create a whole OpcSubscription including its OpcMonitoredItem objects.

C# 

public class OpcSubscriptionSetup


Inheritance Object › OpcSubscriptionSetup

Constructors

Name Description
OpcSubscriptionSetup Initializes a new instance of the OpcSubscriptionSetup class.
OpcSubscriptionSetup(IEnumerable) Initializes a new instance of the OpcSubscriptionSetup class using the sequence of monitoredItems.
OpcSubscriptionSetup(OpcMonitoredItem) Initializes a new instance of the OpcSubscriptionSetup class using the sequence of monitoredItems.

Properties

Name Description
Changed Occurs then a monitored is added, modified, deleted or changes on the OpcSubscription were applied.
DataChangeReceived Occurs then a monitored item receives an event notification which is not handled by an OpcDataChangeReceivedEventHandler on its DataChangeReceived event.
DisplayName Gets or sets the name of the OpcSubscription used just for display purpose in the client application.
EventReceived Occurs then a monitored item receives an event notification which is not handled by an OpcEventReceivedEventHandler on its EventReceived event.
KeepAliveCount Gets or sets a value which defines the requested number of times the publishing timer have to expire without any notification being sent before the server have to send a keep-alive message to the client.
LifetimeCount Gets or sets a value which defines the requested number of times the publishing timer have to expire without any publish request before the server have to delete this OpcSubscription.
MaxMessageCount Gets or sets the maximum number of notifications to keep in the cache.
MaxNotificationsPerPublish Gets or sets a value which defines the maximum number of notifications that the client wants to receive in a single publish response.
MinLifetimeInterval Gets or sets a value which defines the minimum lifetime interval to apply in respect of the PublishingInterval and the LifetimeCount configured.
MonitoredItems Gets a read-only collection of OpcMonitoredItem instances associated with this OpcSubscription.
NotificationReceived Occurs then a OpcNotification for this OpcSubscription has been received by the session which owns this OpcSubscription.
Priority Gets or sets a value which defines the relative priority of the subscription used to priorize notifications being send then more than one subscription is to be notified.
PublishingInterval Gets or sets the requested number of milliseconds of the interval within the server have to send cyclic notifications to the client.
PublishingIsEnabled Gets or sets a value indicating whether publishing is enabled for this OpcSubscription.
ReceivedDataChangeCallback Gets or sets the callback used to process data changes of the monitored items associated with this OpcSubscription.
ReceivedEventCallback Gets or sets the callback used to process events of the monitored items associated with this OpcSubscription.
TimestampsToReturn Gets or sets the timestamps the server shall transmit for each monitored item.
UseMonitoredItemDataCache Gets or sets a value indicating whether this OpcSubscription shall forward notifications received from the server to monitored item individual caches. This enables the monitored items to process the data changes and event fields on their own.

Methods

Name Description
AddMonitoredItem(IEnumerable) Adds the monitored items specified by items to this OpcSubscription.
AddMonitoredItem(OpcMonitoredItem) Adds the monitored item specified by item to this OpcSubscription.
AddMonitoredItem(OpcNodeId) Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcAttribute) Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcAttribute, OpcDataChangeFilter, OpcDataChangeReceivedEventHandler) Adds a new monitored item which subscribes to the attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(OpcNodeId, OpcAttribute, OpcDataChangeReceivedEventHandler) Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcAttribute, OpcEventFilter, OpcEventReceivedEventHandler) Adds a new monitored item which subscribes to the attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(OpcNodeId, OpcAttribute, OpcEventReceivedEventHandler) Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcAttribute, OpcMonitoringFilter) Adds a new monitored item which subscribes to the attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(OpcNodeId, OpcDataChangeFilter, OpcDataChangeReceivedEventHandler) Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(OpcNodeId, OpcDataChangeReceivedEventHandler) Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcEventFilter, OpcEventReceivedEventHandler) Adds a new monitored item which subscribes to changes on the EventNotifier attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(OpcNodeId, OpcEventReceivedEventHandler) Adds a new monitored item which subscribes to events on the EventNotifier attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcMonitoringFilter) Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(OpcMonitoredItem) Adds the monitored items specified by items to this OpcSubscription.
RemoveMonitoredItem(IEnumerable) Removes the monitored items specified by items from the MonitoredItems of this OpcSubscription.
RemoveMonitoredItem(OpcMonitoredItem) Removes the monitored item specified by item from the MonitoredItems of this OpcSubscription.
RemoveMonitoredItem(OpcMonitoredItem) Removes the monitored items specified by items from the MonitoredItems of this OpcSubscription.
ToString Returns a string that represents the current OpcSubscription.