Reference

OpcSubscriptionSetup Members

Type

OpcSubscriptionSetup

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcSubscriptionSetup

3 overloads

Overload	Description
OpcSubscriptionSetup()	Initializes a new instance of the OpcSubscriptionSetup class.
OpcSubscriptionSetup(IEnumerable<OpcMonitoredItem>)	Initializes a new instance of the OpcSubscriptionSetup class using the sequence of monitoredItems.
OpcSubscriptionSetup(params OpcMonitoredItem[])	Initializes a new instance of the OpcSubscriptionSetup class using the sequence of monitoredItems.

OpcSubscriptionSetup()

Initializes a new instance of the OpcSubscriptionSetup class.

public OpcSubscriptionSetup()

Public Sub New()

OpcSubscriptionSetup(IEnumerable<OpcMonitoredItem>)

Initializes a new instance of the OpcSubscriptionSetup class using the sequence of monitoredItems.

public OpcSubscriptionSetup(IEnumerable<OpcMonitoredItem> monitoredItems)

Public Sub New(monitoredItems As IEnumerable(Of OpcMonitoredItem))

Parameters

Name	Type	Description
monitoredItems	IEnumerable<OpcMonitoredItem>	A sequence of OpcMonitoredItem objects.

Exceptions

Exception	Condition
ArgumentNullException	The monitoredItems is a null reference (Nothing in Visual Basic).

OpcSubscriptionSetup(params OpcMonitoredItem[])

Initializes a new instance of the OpcSubscriptionSetup class using the sequence of monitoredItems.

public OpcSubscriptionSetup(params OpcMonitoredItem[] monitoredItems)

Public Sub New(ParamArray monitoredItems As OpcMonitoredItem())

Parameters

Name	Type	Description
monitoredItems	params OpcMonitoredItem[]	An array of OpcMonitoredItem objects.

Exceptions

Exception	Condition
ArgumentNullException	The monitoredItems is a null reference (Nothing in Visual Basic).

Properties

Changed

Occurs then a monitored is added, modified, deleted or changes on the OpcSubscription were applied.

public OpcSubscriptionChangedEventHandler Changed { get; set; }

Public Property Changed As OpcSubscriptionChangedEventHandler

Property value

OpcSubscriptionChangedEventHandler

DataChangeReceived

Occurs then a monitored item receives an event notification which is not handled by an OpcDataChangeReceivedEventHandler on its DataChangeReceived event.

public OpcDataChangeReceivedEventHandler DataChangeReceived { get; set; }

Public Property DataChangeReceived As OpcDataChangeReceivedEventHandler

Property value

OpcDataChangeReceivedEventHandler

Remarks

This event only occurs if an event notification is not handled by the according DataChangeReceived event handler.

DisplayName

Gets or sets the name of the OpcSubscription used just for display purpose in the client application.

public string DisplayName { get; set; }

Public Property DisplayName As String

Property value

String

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.

public OpcEventReceivedEventHandler EventReceived { get; set; }

Public Property EventReceived As OpcEventReceivedEventHandler

Property value

OpcEventReceivedEventHandler

Remarks

This event only occurs if an event notification is not handled by the according EventReceived event handler.

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.

public long KeepAliveCount { get; set; }

Public Property KeepAliveCount As Long

Property value

Int64

A value of zero indicates that the server have to revise the smallest supported keep-alive count. The default value of this property is 10.

The value of this property configures the keep-alive counter that counts the number of consecutive publishing cycles in which there have been no notifications to report to the client. When the maximum keep-alive count is reached, a publish request is de-queued and used to return a keep-alive message. This keep-alive message informs the client that the subscription is still active. The maximum keep-alive count may be subsequently modified. If there are no publish requests queued, the server waits for the next one to be received and sends the keep-alive immediately without waiting for the next publishing cycle.

The value of the underlying property is an uint which is covered using a long to assure CLS compliance. In fact this restricts the value range of this property to MinValue and MaxValue.

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.

public long LifetimeCount { get; set; }

Public Property LifetimeCount As Long

Property value

Int64

The number of times the publishing timer have to expire without any publish request. A recommended value is at least a minimum of three times of the KeepAliveCount. The default value of this property is 100.

Remarks

The value of the underlying property is an uint which is covered using a long to assure CLS compliance. In fact this restricts the value range of this property to MinValue and MaxValue.

MaxMessageCount

Gets or sets the maximum number of notifications to keep in the cache.

public int MaxMessageCount { get; set; }

Public Property MaxMessageCount As Integer

Property value

Int32

The maximum number of notification to keep in the cache. The default value of this property is 10.

MaxNotificationsPerPublish

Gets or sets a value which defines the maximum number of notifications that the client wants to receive in a single publish response.

public long MaxNotificationsPerPublish { get; set; }

Public Property MaxNotificationsPerPublish As Long

Property value

Int64

The maximum number of notifications that the client wants to receive in a single publish response. The number of notifications per publish is the sum of MonitoredItems in a data change related notification and the number of events in an event notification. The default value of this property is 1000.

Remarks

A value of zero indicates that there is no limit.

The value of the underlying property is an uint which is covered using a long to assure CLS compliance. In fact this restricts the value range of this property to MinValue and MaxValue.

MinLifetimeInterval

Gets or sets a value which defines the minimum lifetime interval to apply in respect of the PublishingInterval and the LifetimeCount configured.

public long MinLifetimeInterval { get; set; }

Public Property MinLifetimeInterval As Long

Property value

Int64

The interval which should be a multiple of the PublishingInterval to assure that the LifetimeCount requested is sensible enough to get covered within the PublishingInterval.

MonitoredItems

Gets a read-only collection of OpcMonitoredItem instances associated with this OpcSubscription.

public OpcMonitoredItemReadOnlyCollection MonitoredItems { get; }

Public ReadOnly Property MonitoredItems As OpcMonitoredItemReadOnlyCollection

Property value

OpcMonitoredItemReadOnlyCollection

An instance of the OpcMonitoredItemReadOnlyCollection class.

Remarks

Use the monitored item related methods of this OpcSubscription to manipulate the items contained in the collection offered by this property.

NotificationFailed

since v2.57

Occurs then a notification message for the OpcSubscription failed to be received, so that its data changes and events do not reach the monitored items.

public OpcNotificationFailedEventHandler NotificationFailed { get; set; }

Public Property NotificationFailed As OpcNotificationFailedEventHandler

Property value

OpcNotificationFailedEventHandler

Remarks

The session requests a failed message again from the server until the server no longer holds it. This event occurs once for each message, however often it fails, and once more with BadMessageNotAvailable when the message is lost. An event which is not handled by this event handler is passed to the NotificationFailed event of the OpcClient which owns the OpcSubscription.

NotificationReceived

Occurs then a OpcNotification for this OpcSubscription has been received by the session which owns this OpcSubscription.

public OpcNotificationReceivedEventHandler NotificationReceived { get; set; }

Public Property NotificationReceived As OpcNotificationReceivedEventHandler

Property value

OpcNotificationReceivedEventHandler

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.

public int Priority { get; set; }

Public Property Priority As Integer

Property value

Int32

The relative priority of the subscription to notify.

Remarks

In case of subscriptions with equal priority the server shall send the notifications in a round-robin fashion. A client that does not require special priority settings should set this value to zero.

The value of the underlying property is a byte which is covered using an int to assure an even API level. In fact this restricts the value range of this property to MinValue and MaxValue.

PublishingInterval

Gets or sets the requested number of milliseconds of the interval within the server have to send cyclic notifications to the client.

public int PublishingInterval { get; set; }

Public Property PublishingInterval As Integer

Property value

Int32

The interval within the server have to send cyclic notifications to the client. A value of zero or negative indicates that the server have to revise the fastest supported publishing interval.

Remarks

The publishing interval of a subscription defines the cyclic rate at which the subscription executes. Each time it executes, it attempts to send a message to the client. Messages contain notifications that have not yet been reported to client.

The negotiated value of this property is used as the default sampling interval for the MonitoredItems assigned to this OpcSubscription.

PublishingIsEnabled

Gets or sets a value indicating whether publishing is enabled for this OpcSubscription.

public bool PublishingIsEnabled { get; set; }

Public Property PublishingIsEnabled As Boolean

Property value

Boolean

The value true if publishing is enabled for this OpcSubscription; otherwise the value false. The default value of this property is true.

Remarks

The value of this property does not affect the value of the monitoring mode property of the MonitoredItems.

ReceivedDataChangeCallback

Gets or sets the callback used to process data changes of the monitored items associated with this OpcSubscription.

public OpcDataChangeReceivedCallback ReceivedDataChangeCallback { get; set; }

Public Property ReceivedDataChangeCallback As OpcDataChangeReceivedCallback

Property value

OpcDataChangeReceivedCallback

A OpcDataChangeReceivedCallback used to process data change items. The value can also be a null reference (Nothing in Visual Basic).

Remarks

Use this property to directly handle all data change items without to rely on the chain of registered event handlers.

ReceivedEventCallback

Gets or sets the callback used to process events of the monitored items associated with this OpcSubscription.

public OpcEventReceivedCallback ReceivedEventCallback { get; set; }

Public Property ReceivedEventCallback As OpcEventReceivedCallback

Property value

OpcEventReceivedCallback

A OpcDataChangeReceivedCallback used to process event items. The value can also be a null reference (Nothing in Visual Basic).

Remarks

Use this property to directly handle all event items without to rely on the chain of registered event handlers.

TimestampsToReturn

Gets or sets the timestamps the server shall transmit for each monitored item.

public OpcTimestampsToReturn TimestampsToReturn { get; set; }

Public Property TimestampsToReturn As OpcTimestampsToReturn

Property value

OpcTimestampsToReturn

One of the members defined by the OpcTimestampsToReturn enumeration. The default value of this property is Both.

Remarks

The "timestamps to return" criteria is only applied to OpcValue instances. This means that in case of monitoring events only event fields of the type OpcValue are effected by the value of this property.

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.

public bool UseMonitoredItemDataCache { get; set; }

Public Property UseMonitoredItemDataCache As Boolean

Property value

Boolean

The value true if the OpcMonitoredItem instances associated with this OpcSubscription receive their own item-related notification and can process the notification data on their own; otherwise the value false. The default value of this property is true.

Methods

AddMonitoredItem

15 overloads

Overload	Description
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, OpcDataChangeReceivedEventHandler)	Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcEventReceivedEventHandler)	Adds a new monitored item which subscribes to events on the EventNotifier 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, OpcDataChangeReceivedEventHandler)	Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.
AddMonitoredItem(OpcNodeId, OpcAttribute, OpcEventReceivedEventHandler)	Adds a new monitored item which subscribes to the 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(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, 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, 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, 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, OpcEventFilter, OpcEventReceivedEventHandler)	Adds a new monitored item which subscribes to the attribute of the node specified by nodeId using the further configured filter.
AddMonitoredItem(IEnumerable<OpcMonitoredItem>)	Adds the monitored items specified by items to this OpcSubscription.
AddMonitoredItem(params OpcMonitoredItem[])	Adds the monitored items specified by items to this OpcSubscription.

AddMonitoredItem(OpcMonitoredItem)

Adds the monitored item specified by item to this OpcSubscription.

public void AddMonitoredItem(OpcMonitoredItem item)

Public Sub AddMonitoredItem(item As OpcMonitoredItem)

Parameters

Name	Type	Description
item	OpcMonitoredItem	The OpcMonitoredItem to add.

Exceptions

Exception	Condition
ArgumentNullException	The item is a null reference (Nothing in Visual Basic).

AddMonitoredItem(OpcNodeId)

Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId.

public OpcMonitoredItem AddMonitoredItem(OpcNodeId nodeId)

Public Function AddMonitoredItem(nodeId As OpcNodeId) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its Value attribute is to be monitored.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

AddMonitoredItem(OpcNodeId, OpcDataChangeReceivedEventHandler)

Adds a new monitored item which subscribes to changes on the Value attribute of the node specified by nodeId.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcDataChangeReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    received As OpcDataChangeReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its Value attribute is to be monitored.
received	OpcDataChangeReceivedEventHandler	The OpcDataChangeReceivedEventHandler method to assign as the event handler of the DataChangeReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

AddMonitoredItem(OpcNodeId, OpcEventReceivedEventHandler)

Adds a new monitored item which subscribes to events on the EventNotifier attribute of the node specified by nodeId.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcEventReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    received As OpcEventReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its EventNotifier attribute is to be monitored.
received	OpcEventReceivedEventHandler	The OpcEventReceivedEventHandler method to assign as the event handler of the EventReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

AddMonitoredItem(OpcNodeId, OpcAttribute)

Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcAttribute attribute)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    attribute As OpcAttribute) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its attribute is to be monitored.
attribute	OpcAttribute	The OpcAttribute to monitor.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

AddMonitoredItem(OpcNodeId, OpcAttribute, OpcDataChangeReceivedEventHandler)

Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcAttribute attribute,
    OpcDataChangeReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    attribute As OpcAttribute,
    received As OpcDataChangeReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its attribute is to be monitored.
attribute	OpcAttribute	The OpcAttribute to monitor.
received	OpcDataChangeReceivedEventHandler	The OpcDataChangeReceivedEventHandler method to assign as the event handler of the DataChangeReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

AddMonitoredItem(OpcNodeId, OpcAttribute, OpcEventReceivedEventHandler)

Adds a new monitored item which subscribes to the attribute of the node specified by nodeId.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcAttribute attribute,
    OpcEventReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    attribute As OpcAttribute,
    received As OpcEventReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its attribute is to be monitored.
attribute	OpcAttribute	The OpcAttribute to monitor.
received	OpcEventReceivedEventHandler	The OpcEventReceivedEventHandler method to assign as the event handler of the EventReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

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.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcMonitoringFilter filter)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    filter As OpcMonitoringFilter) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its Value attribute is to be monitored.
filter	OpcMonitoringFilter	The OpcMonitoringFilter (either a OpcDataChangeFilter or a OpcEventFilter) to use to apply different conditions while monitoring the attribute.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

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.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcDataChangeFilter filter,
    OpcDataChangeReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    filter As OpcDataChangeFilter,
    received As OpcDataChangeReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its Value attribute is to be monitored.
filter	OpcDataChangeFilter	The OpcDataChangeFilter to use to apply different conditions while monitoring the attribute.
received	OpcDataChangeReceivedEventHandler	The OpcDataChangeReceivedEventHandler method to assign as the event handler of the DataChangeReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

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.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcEventFilter filter,
    OpcEventReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    filter As OpcEventFilter,
    received As OpcEventReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its EventNotifier attribute is to be monitored.
filter	OpcEventFilter	The OpcEventFilter to use to apply different conditions while monitoring the attribute.
received	OpcEventReceivedEventHandler	The OpcEventReceivedEventHandler method to assign as the event handler of the EventReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

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.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcAttribute attribute,
    OpcMonitoringFilter filter)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    attribute As OpcAttribute,
    filter As OpcMonitoringFilter) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its attribute is to be monitored.
attribute	OpcAttribute	The OpcAttribute to monitor.
filter	OpcMonitoringFilter	The OpcMonitoringFilter (either a OpcDataChangeFilter or a OpcEventFilter) to use to apply different conditions while monitoring the attribute.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

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.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcAttribute attribute,
    OpcDataChangeFilter filter,
    OpcDataChangeReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    attribute As OpcAttribute,
    filter As OpcDataChangeFilter,
    received As OpcDataChangeReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its attribute is to be monitored.
attribute	OpcAttribute	The OpcAttribute to monitor.
filter	OpcDataChangeFilter	The OpcDataChangeFilter to use to apply different conditions while monitoring the attribute.
received	OpcDataChangeReceivedEventHandler	The OpcDataChangeReceivedEventHandler method to assign as the event handler of the DataChangeReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

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.

public OpcMonitoredItem AddMonitoredItem(
    OpcNodeId nodeId,
    OpcAttribute attribute,
    OpcEventFilter filter,
    OpcEventReceivedEventHandler received)

Public Function AddMonitoredItem(
    nodeId As OpcNodeId,
    attribute As OpcAttribute,
    filter As OpcEventFilter,
    received As OpcEventReceivedEventHandler) As OpcMonitoredItem

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node its attribute is to be monitored.
attribute	OpcAttribute	The OpcAttribute to monitor.
filter	OpcEventFilter	The OpcEventFilter to use to apply different conditions while monitoring the attribute.
received	OpcEventReceivedEventHandler	The OpcEventReceivedEventHandler method to assign as the event handler of the EventReceived event or a null reference (Nothing in Visual Basic) if there no event handler is to be assigned first.

Returns

OpcMonitoredItem

A new instance of the OpcMonitoredItem class setup with the information specified. The monitored item will then monitor the node identified by the values passed to this method.

Exceptions

Exception	Condition
ArgumentException	The nodeId is empty.
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

AddMonitoredItem(IEnumerable<OpcMonitoredItem>)

Adds the monitored items specified by items to this OpcSubscription.

public void AddMonitoredItem(IEnumerable<OpcMonitoredItem> items)

Public Sub AddMonitoredItem(items As IEnumerable(Of OpcMonitoredItem))

Parameters

Name	Type	Description
items	IEnumerable<OpcMonitoredItem>	A sequence of OpcMonitoredItem istances to add.

Exceptions

Exception	Condition
ArgumentNullException	The items is a null reference (Nothing in Visual Basic).

AddMonitoredItem(params OpcMonitoredItem[])

Adds the monitored items specified by items to this OpcSubscription.

public void AddMonitoredItem(params OpcMonitoredItem[] items)

Public Sub AddMonitoredItem(ParamArray items As OpcMonitoredItem())

Parameters

Name	Type	Description
items	params OpcMonitoredItem[]	An array of OpcMonitoredItem istances to add.

Exceptions

Exception	Condition
ArgumentNullException	The items is a null reference (Nothing in Visual Basic).

RemoveMonitoredItem

3 overloads

Overload	Description
RemoveMonitoredItem(OpcMonitoredItem)	Removes the monitored item specified by item from the MonitoredItems of this OpcSubscription.
RemoveMonitoredItem(IEnumerable<OpcMonitoredItem>)	Removes the monitored items specified by items from the MonitoredItems of this OpcSubscription.
RemoveMonitoredItem(params OpcMonitoredItem[])	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.

public void RemoveMonitoredItem(OpcMonitoredItem item)

Public Sub RemoveMonitoredItem(item As OpcMonitoredItem)

Parameters

Name	Type	Description
item	OpcMonitoredItem	The OpcMonitoredItem to remove.

Exceptions

Exception	Condition
ArgumentNullException	The item is a null reference (Nothing in Visual Basic).

RemoveMonitoredItem(IEnumerable<OpcMonitoredItem>)

Removes the monitored items specified by items from the MonitoredItems of this OpcSubscription.

public void RemoveMonitoredItem(IEnumerable<OpcMonitoredItem> items)

Public Sub RemoveMonitoredItem(items As IEnumerable(Of OpcMonitoredItem))

Parameters

Name	Type	Description
items	IEnumerable<OpcMonitoredItem>	A sequence of OpcMonitoredItem instances to remove.

Exceptions

Exception	Condition
ArgumentNullException	The items is a null reference (Nothing in Visual Basic).

RemoveMonitoredItem(params OpcMonitoredItem[])

Removes the monitored items specified by items from the MonitoredItems of this OpcSubscription.

public void RemoveMonitoredItem(params OpcMonitoredItem[] items)

Public Sub RemoveMonitoredItem(ParamArray items As OpcMonitoredItem())

Parameters

Name	Type	Description
items	params OpcMonitoredItem[]	An array of OpcMonitoredItem instances to remove.

Exceptions

Exception	Condition
ArgumentNullException	The items is a null reference (Nothing in Visual Basic).

ToString

override

Returns a string that represents the current OpcSubscription.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string that represents the current OpcSubscription including the used DisplayName, the PublishingIsEnabled and the PublishingInterval.

Overrides

ToString()