Reference

OpcNodeManager Members

Type

OpcNodeManager

Namespace

Opc.UaFx.Server

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Constructors

OpcNodeManager

protected · 3 overloads

Overload	Description
OpcNodeManager(OpcNamespace, params OpcNamespace[])protected · since v2.8	Initializes a new instance of the OpcNodeManager class using the defaultNamespace and additionally specified namespaces.
OpcNodeManager(string, params string[])protected	Initializes a new instance of the OpcNodeManager class using the defaultNamespace and additionally specified string-based namespaces.
OpcNodeManager(Uri, params Uri[])protected	Initializes a new instance of the OpcNodeManager class using the defaultNamespaceUri and additionally specified Uri-based namespaceUris.

OpcNodeManager(OpcNamespace, params OpcNamespace[])

protected · since v2.8

Initializes a new instance of the OpcNodeManager class using the defaultNamespace and additionally specified namespaces.

protected OpcNodeManager(
    OpcNamespace defaultNamespace,
    params OpcNamespace[] namespaces)

Protected Sub New(
    defaultNamespace As OpcNamespace,
    ParamArray namespaces As OpcNamespace())

Parameters

Name	Type	Description
defaultNamespace	OpcNamespace	The default OpcNamespace used for the DefaultNamespace property. In case there AssignDefaultNamespaceOfManager is equals true (the default value) the Name and Id of the OpcNode instances defined are linked to this namespace in case there is no namespace information associated to them.
namespaces	params OpcNamespace[]	An array of OpcNamespace instances indicating which namespaces are as well maintained by the new OpcNodeManager. The instances can then found in the Namespaces property as well.

Exceptions

Exception	Condition
ArgumentException	The defaultNamespace or one of the items in namespaces refers to a namespace which presets a namespace index. The according namespace index is determined by the server.
ArgumentNullException	The defaultNamespace or one of the items in namespaces is a null reference (Nothing in Visual Basic).

OpcNodeManager(string, params string[])

protected

Initializes a new instance of the OpcNodeManager class using the defaultNamespace and additionally specified string-based namespaces.

protected OpcNodeManager(string defaultNamespace, params string[] namespaces)

Protected Sub New(defaultNamespace As String, ParamArray namespaces As String())

Parameters

Name	Type	Description
defaultNamespace	String	The string representation of the default OpcNamespace which is used for the DefaultNamespace property. In case there AssignDefaultNamespaceOfManager is equals true (the default value) the Name and Id of the OpcNode instances defined are linked to this namespace in case there is no namespace information associated to them.
namespaces	params String[]	An array of string representations of the OpcNamespace indicating which namespaces are as well maintained by the new OpcNodeManager. The used OpcNamespace instances can be found in the Namespaces property as well.

Exceptions

Exception	Condition
ArgumentException	The defaultNamespace or one of the items in namespaces is an empty string.
ArgumentNullException	The defaultNamespace or one of the items in namespaces is a null reference (Nothing in Visual Basic).

OpcNodeManager(Uri, params Uri[])

protected

Initializes a new instance of the OpcNodeManager class using the defaultNamespaceUri and additionally specified Uri-based namespaceUris.

protected OpcNodeManager(Uri defaultNamespaceUri, params Uri[] namespaceUris)

Protected Sub New(defaultNamespaceUri As Uri, ParamArray namespaceUris As Uri())

Parameters

Name	Type	Description
defaultNamespaceUri	Uri	The Uri representation of the default OpcNamespace which is used for the DefaultNamespace property. In case there AssignDefaultNamespaceOfManager is equals true (the default value) the Name and Id of the OpcNode instances defined are linked to this namespace in case there is no namespace information associated to them.
namespaceUris	params Uri[]	An array of Uri representations of the OpcNamespace indicating which namespaces are as well maintained by the new OpcNodeManager. The used OpcNamespace instances can be found in the Namespaces property as well.

Exceptions

Exception	Condition
ArgumentNullException	The defaultNamespaceUri or one of the items in namespaceUris is a null reference (Nothing in Visual Basic).

Properties

DefaultNamespace

Gets the default namespace of the node manager.

public OpcNamespace DefaultNamespace { get; }

Public ReadOnly Property DefaultNamespace As OpcNamespace

Property value

OpcNamespace

The OpcNamespace specified as the default namespace when the node manager was created. When the server is started, the instance is replaced by the namespace the server has registered for it.

DefaultNamespaceIndex

Gets the index of the default namespace of the node manager.

public int DefaultNamespaceIndex { get; }

Public ReadOnly Property DefaultNamespaceIndex As Integer

Property value

Int32

The Index of the DefaultNamespace, which the server assigns when it is started.

DefaultNamespaceUri

Gets the URI of the default namespace of the node manager.

public Uri DefaultNamespaceUri { get; }

Public ReadOnly Property DefaultNamespaceUri As Uri

Property value

Uri

The Uri of the DefaultNamespace.

DefaultNamespaceValue

since v2.8

Gets the textual value of the default namespace of the node manager.

public string DefaultNamespaceValue { get; }

Public ReadOnly Property DefaultNamespaceValue As String

Property value

String

The Value of the DefaultNamespace.

Namespaces

since v2.8

Gets the namespaces maintained by the node manager.

public OpcReadOnlyNamespaceCollection Namespaces { get; }

Public ReadOnly Property Namespaces As OpcReadOnlyNamespaceCollection

Property value

OpcReadOnlyNamespaceCollection

An OpcReadOnlyNamespaceCollection which starts with the DefaultNamespace, followed by the further namespaces specified when the node manager was created, without duplicates.

NodeIdFactory

protected · virtual

Gets or sets the OpcNodeIdFactory instance used by this node manager to determine / create node identifiers for the nodes provided / defined by the node manager.

protected virtual OpcNodeIdFactory NodeIdFactory { get; set; }

Protected Overridable Property NodeIdFactory As OpcNodeIdFactory

Property value

OpcNodeIdFactory

An instance of the OpcNodeIdFactory class. In case there is no custom OpcNodeIdFactory defined. The Factory is used.

Nodes

Gets the nodes of the node manager.

public OpcReadOnlyNodeCollection Nodes { get; }

Public ReadOnly Property Nodes As OpcReadOnlyNodeCollection

Property value

OpcReadOnlyNodeCollection

An OpcReadOnlyNodeCollection with the nodes of the address space part maintained by the node manager; an empty collection until the server has created the address space.

NodeSetImportOptions

protected · virtual · since v2.50

Gets or sets the options to use to import the node sets provided by ImportNodes.

protected virtual OpcNodeSetImportOptions NodeSetImportOptions { get; set; }

Protected Overridable Property NodeSetImportOptions As OpcNodeSetImportOptions

Property value

OpcNodeSetImportOptions

A combination of the OpcNodeSetImportOptions flags. The default value is None.

Remarks

The flags CompleteDataTypeDefinitionFields and CompleteDataTypeDefinitionDefaultEncoding apply to the data types of all node managers of the server as soon as one node manager sets them.

NotifierNodes

Gets the nodes of the node manager which act as notifiers (event sources) of the 'Server' node.

public OpcReadOnlyNodeCollection NotifierNodes { get; }

Public ReadOnly Property NotifierNodes As OpcReadOnlyNodeCollection

Property value

OpcReadOnlyNodeCollection

An OpcReadOnlyNodeCollection with the notifier nodes; an empty collection until the server has created the address space.

SyncRoot

protected

Gets the object the node manager locks while it notifies monitored items about changes of its nodes and while it creates, modifies or deletes monitored items, browses, translates browse paths or accesses the history of its nodes.

protected object SyncRoot { get; }

Protected ReadOnly Property SyncRoot As Object

Property value

Object

The lock of this node manager. Every node manager has a lock of its own.

Remarks

The SDK does not synchronize changes of nodes. A value set, ApplyChanges and ReportEvent can be called from any thread, but changes of the same node from several threads at once can lose a notification or report a torn state.

Holding this lock while changing and applying changes serializes them with other code holding it and with the notification of monitored items. It does not serialize them with the Read and Write services of clients, which only lock the node accessed, nor with method calls, which run without this lock.

The notification of monitored items and the creation of monitored items call read callbacks and the monitored item events with this lock held. Such code must not wait for another thread that holds the lock of a different node manager and reports an event, because an event takes the lock of the node manager of every notifier it passes.

The lock is not public, because holding it outside of the node manager would not make changes atomic to clients either. Code that changes several nodes together therefore belongs into a method of the node manager, which can hold this lock.

SystemContext

protected

Gets the context which the node manager uses to access its nodes.

protected OpcContext SystemContext { get; }

Protected ReadOnly Property SystemContext As OpcContext

Property value

OpcContext

The OpcContext of the server for the node manager; a null reference (Nothing in Visual Basic) until the server using the node manager has been started.

UseAsyncMethodCalls

protected · virtual · since v2.24

Gets a value indicating whether every call to a OpcMethodNode defined by the current OpcNodeManager is to be processed asynchronously using one worker thread per method call.

protected virtual bool UseAsyncMethodCalls { get; }

Protected Overridable ReadOnly Property UseAsyncMethodCalls As Boolean

Property value

Boolean

The value true if every method call (which belongs to OpcMethodNode objects defined by the current OpcNodeManager) is to be processed parallel to each other; otherwise the value false to process method calls in their sequence. The default value is false.

Remarks

This behavior can be controlled by each node manager on its own. Just override the UseAsyncMethodCalls property and provide the value true in the node managers which shall process method calls in parallel.

Every OpcMethodNode defined with a delegate to a method its return value provides a Task is already processed in parallel.

Use the UseAsyncMethodCalls property to control this behavior for every node manager used.

Methods

AddNode

8 overloads

Overload	Description
AddNode(IOpcNode)	Adds the node specified to the address space of the node manager.
AddNode(OpcContext, IOpcNode)since v2.7	Adds the node specified to the address space of the node manager using the context specified.
AddNode(IOpcNode, IEnumerable<IOpcNodeReferenceAware>)protected · since v2.7	Adds the node specified to the address space of the node manager using the references specified.
AddNode(IOpcNode, params IOpcNodeReferenceAware[])protected · since v2.7	Adds the node specified to the address space of the node manager using the references specified.
AddNode(IOpcNode, OpcNodeReferenceCollection)protected · since v2.7	Adds the node specified to the address space of the node manager using the references specified.
AddNode(OpcContext, IOpcNode, IEnumerable<IOpcNodeReferenceAware>)protected · virtual · since v2.7	Adds the node specified to the address space of the node manager using the context and references specified.
AddNode(OpcContext, IOpcNode, params IOpcNodeReferenceAware[])protected · since v2.7	Adds the node specified to the address space of the node manager using the context and references specified.
AddNode(OpcContext, IOpcNode, OpcNodeReferenceCollection)protected · virtual · since v2.7	Adds the node specified to the address space of the node manager using the context and references specified.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The server using the node manager has not yet been started.

AddNode(IOpcNode)

Adds the node specified to the address space of the node manager.

public void AddNode(IOpcNode node)

Public Sub AddNode(node As IOpcNode)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode to add.

Exceptions

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

Remarks

A node which is already part of the address space is not added again.

AddNode(OpcContext, IOpcNode)

since v2.7

Adds the node specified to the address space of the node manager using the context specified.

public void AddNode(OpcContext context, IOpcNode node)

Public Sub AddNode(context As OpcContext, node As IOpcNode)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to add the node.
node	IOpcNode	The IOpcNode to add.

Exceptions

Exception	Condition
ArgumentNullException	The context or node is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNode(IOpcNode, IEnumerable<IOpcNodeReferenceAware>)

protected · since v2.7

Adds the node specified to the address space of the node manager using the references specified.

protected void AddNode(
    IOpcNode node,
    IEnumerable<IOpcNodeReferenceAware> references)

Protected Sub AddNode(
    node As IOpcNode,
    references As IEnumerable(Of IOpcNodeReferenceAware))

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode to add.
references	IEnumerable<IOpcNodeReferenceAware>	A sequence of IOpcNodeReferenceAware instances which define the references of the node to further nodes.

Exceptions

Exception	Condition
ArgumentNullException	The node or references is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNode(IOpcNode, params IOpcNodeReferenceAware[])

protected · since v2.7

Adds the node specified to the address space of the node manager using the references specified.

protected void AddNode(
    IOpcNode node,
    params IOpcNodeReferenceAware[] references)

Protected Sub AddNode(
    node As IOpcNode,
    ParamArray references As IOpcNodeReferenceAware())

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode to add.
references	params IOpcNodeReferenceAware[]	An array of IOpcNodeReferenceAware instances which define the references of the node to further nodes.

Exceptions

Exception	Condition
ArgumentNullException	The node or references is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNode(IOpcNode, OpcNodeReferenceCollection)

protected · since v2.7

Adds the node specified to the address space of the node manager using the references specified.

protected void AddNode(IOpcNode node, OpcNodeReferenceCollection references)

Protected Sub AddNode(
    node As IOpcNode,
    references As OpcNodeReferenceCollection)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode to add.
references	OpcNodeReferenceCollection	The OpcNodeReferenceCollection which defines the references of the node to further nodes.

Exceptions

Exception	Condition
ArgumentNullException	The node or references is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNode(OpcContext, IOpcNode, IEnumerable<IOpcNodeReferenceAware>)

protected · virtual · since v2.7

Adds the node specified to the address space of the node manager using the context and references specified.

protected virtual void AddNode(
    OpcContext context,
    IOpcNode node,
    IEnumerable<IOpcNodeReferenceAware> references)

Protected Overridable Sub AddNode(
    context As OpcContext,
    node As IOpcNode,
    references As IEnumerable(Of IOpcNodeReferenceAware))

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to add the node.
node	IOpcNode	The IOpcNode to add.
references	IEnumerable<IOpcNodeReferenceAware>	A sequence of IOpcNodeReferenceAware instances which define the references of the node to further nodes.

Exceptions

Exception	Condition
ArgumentNullException	The context, node or references is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNode(OpcContext, IOpcNode, params IOpcNodeReferenceAware[])

protected · since v2.7

Adds the node specified to the address space of the node manager using the context and references specified.

protected void AddNode(
    OpcContext context,
    IOpcNode node,
    params IOpcNodeReferenceAware[] references)

Protected Sub AddNode(
    context As OpcContext,
    node As IOpcNode,
    ParamArray references As IOpcNodeReferenceAware())

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to add the node.
node	IOpcNode	The IOpcNode to add.
references	params IOpcNodeReferenceAware[]	An array of IOpcNodeReferenceAware instances which define the references of the node to further nodes.

Exceptions

Exception	Condition
ArgumentNullException	The context, node or references is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNode(OpcContext, IOpcNode, OpcNodeReferenceCollection)

protected · virtual · since v2.7

Adds the node specified to the address space of the node manager using the context and references specified.

protected virtual void AddNode(
    OpcContext context,
    IOpcNode node,
    OpcNodeReferenceCollection references)

Protected Overridable Sub AddNode(
    context As OpcContext,
    node As IOpcNode,
    references As OpcNodeReferenceCollection)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to add the node.
node	IOpcNode	The IOpcNode to add.
references	OpcNodeReferenceCollection	The OpcNodeReferenceCollection which defines the references of the node to further nodes.

Exceptions

Exception	Condition
ArgumentNullException	The context, node or references is a null reference (Nothing in Visual Basic).

Remarks

A node which is already part of the address space is not added again.

AddNotifierNode

protected

Adds the node to the collection of 'root' notifiers (= event sources) of the 'Server' node.

protected void AddNotifierNode(IOpcNode node)

Protected Sub AddNotifierNode(node As IOpcNode)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode instance acting as the notifier of the 'Server' node.

Exceptions

Exception	Condition
ArgumentNullException	The node is a null reference (Nothing in Visual Basic).
InvalidOperationException	The master node has not yet been created, therefore the operation is at the moment not available.

Browse

protected · virtual · since v2.7

Browses the references of a node of the node manager on behalf of a client.

protected virtual OpcBrowsePoint Browse(
    OpcContext context,
    OpcBrowsePoint browsePoint,
    OpcReferenceDescriptionCollection references)

Protected Overridable Function Browse(
    context As OpcContext,
    browsePoint As OpcBrowsePoint,
    references As OpcReferenceDescriptionCollection) As OpcBrowsePoint

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the browse operation.
browsePoint	OpcBrowsePoint	The OpcBrowsePoint which describes the node and the references to browse and the position to continue at.
references	OpcReferenceDescriptionCollection	The OpcReferenceDescriptionCollection to which the references found are added.

Returns

OpcBrowsePoint

An OpcBrowsePoint to continue browsing at if not all references could be provided; otherwise a null reference (Nothing in Visual Basic).

CreateHistory

protected · virtual

Creates the history entries of the values specified for the node specified.

protected virtual OpcStatusCollection CreateHistory(
    IOpcNode node,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Protected Overridable Function CreateHistory(
    node As IOpcNode,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is changed.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values to create.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value. If RetrieveNodeHistoryProvider provides no provider, each result has the code BadHistoryOperationUnsupported.

CreateNodes

protected · virtual

When overridden in a derived class, creates the nodes of the address space part maintained by the node manager.

protected virtual IEnumerable<IOpcNode> CreateNodes(
    OpcNodeReferenceCollection references)

Protected Overridable Function CreateNodes(
    references As OpcNodeReferenceCollection) As IEnumerable(Of IOpcNode)

Parameters

Name	Type	Description
references	OpcNodeReferenceCollection	The OpcNodeReferenceCollection to which the references of the created nodes to further nodes (e.g. to their parent nodes) are to be added.

Returns

IEnumerable<IOpcNode>

A sequence of the IOpcNode instances created. The base implementation provides no nodes.

Remarks

The server calls the method when it creates its address space while it is started. An exception thrown by the method is passed on as an OpcException and fails the start of the server.

DeleteHistory

protected · virtual · 3 overloads

Overload	Description
DeleteHistory(IOpcNode, OpcHistoryModificationInfo, IEnumerable<DateTime>)protected · virtual	Deletes the history entries at the times specified of the node specified.
DeleteHistory(IOpcNode, OpcHistoryModificationInfo, OpcValueCollection)protected · virtual	Deletes the history entries of the values specified of the node specified.
DeleteHistory(IOpcNode, OpcHistoryModificationInfo, DateTime?, DateTime?, OpcDeleteHistoryOptions)protected · virtual	Deletes the history entries of the node specified within the time range specified.

DeleteHistory(IOpcNode, OpcHistoryModificationInfo, IEnumerable<DateTime>)

protected · virtual

Deletes the history entries at the times specified of the node specified.

protected virtual OpcStatusCollection DeleteHistory(
    IOpcNode node,
    OpcHistoryModificationInfo modificationInfo,
    IEnumerable<DateTime> times)

Protected Overridable Function DeleteHistory(
    node As IOpcNode,
    modificationInfo As OpcHistoryModificationInfo,
    times As IEnumerable(Of Date)) As OpcStatusCollection

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is changed.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
times	IEnumerable<DateTime>	A sequence of the timestamps of the entries to delete.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per timestamp. If RetrieveNodeHistoryProvider provides no provider, each result has the code BadHistoryOperationUnsupported.

DeleteHistory(IOpcNode, OpcHistoryModificationInfo, OpcValueCollection)

protected · virtual

Deletes the history entries of the values specified of the node specified.

protected virtual OpcStatusCollection DeleteHistory(
    IOpcNode node,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Protected Overridable Function DeleteHistory(
    node As IOpcNode,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is changed.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values whose entries are to be deleted.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value. If RetrieveNodeHistoryProvider provides no provider, each result has the code BadHistoryOperationUnsupported.

DeleteHistory(IOpcNode, OpcHistoryModificationInfo, DateTime?, DateTime?, OpcDeleteHistoryOptions)

protected · virtual

Deletes the history entries of the node specified within the time range specified.

protected virtual OpcStatusCollection DeleteHistory(
    IOpcNode node,
    OpcHistoryModificationInfo modificationInfo,
    DateTime? startTime,
    DateTime? endTime,
    OpcDeleteHistoryOptions options)

Protected Overridable Function DeleteHistory(
    node As IOpcNode,
    modificationInfo As OpcHistoryModificationInfo,
    startTime As Date?,
    endTime As Date?,
    options As OpcDeleteHistoryOptions) As OpcStatusCollection

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is changed.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
startTime	Nullable<DateTime>	The begin of the time range or a null reference (Nothing in Visual Basic) if the range is not limited at its begin.
endTime	Nullable<DateTime>	The end of the time range or a null reference (Nothing in Visual Basic) if the range is not limited at its end.
options	OpcDeleteHistoryOptions	A combination of the OpcDeleteHistoryOptions flags which specify the entries to delete.

Returns

OpcStatusCollection

An OpcStatusCollection with the result of the operation. If RetrieveNodeHistoryProvider provides no provider, the collection contains one result with the code BadHistoryOperationUnsupported.

DeleteNodes

protected · virtual

When overridden in a derived class, releases the nodes of the node manager.

protected virtual void DeleteNodes()

Protected Overridable Sub DeleteNodes()

Remarks

The server calls the method when it deletes its address space. The base implementation does nothing.

Dispose

2 overloads

Overload	Description
Dispose()	Releases all resources used by the OpcNodeManager.
Dispose(bool)protected · virtual	Releases the unmanaged resources used by the OpcNodeManager and optionally releases the managed resources.

Dispose()

Releases all resources used by the OpcNodeManager.

public void Dispose()

Public Sub Dispose()

Implements

Dispose()

Dispose(bool)

protected · virtual

Releases the unmanaged resources used by the OpcNodeManager and optionally releases the managed resources.

protected virtual void Dispose(bool disposing)

Protected Overridable Sub Dispose(disposing As Boolean)

Parameters

Name	Type	Description
disposing	Boolean	The value true to release both managed and unmanaged resources; otherwise the value false to release only unmanaged resources.

ExportNodes

2 overloads

Overload	Description
ExportNodes()since v2.11	Exports the Nodes of the node manager using the Default options.
ExportNodes(OpcNodeExportOptions)since v2.12	Exports the Nodes of the node manager using the options specified.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The server using the node manager has not yet been started.

ExportNodes()

since v2.11

Exports the Nodes of the node manager using the Default options.

public IEnumerable<OpcNodeSet> ExportNodes()

Public Function ExportNodes() As IEnumerable(Of OpcNodeSet)

Returns

IEnumerable<OpcNodeSet>

A sequence of OpcNodeSet instances, one per namespace of the node manager which contains nodes.

Remarks

The nodes are exported while the sequence is enumerated; the exception is thrown then as well. Nodes of a namespace which is not maintained by the node manager (see Namespaces) are not exported.

ExportNodes(OpcNodeExportOptions)

since v2.12

Exports the Nodes of the node manager using the options specified.

public IEnumerable<OpcNodeSet> ExportNodes(OpcNodeExportOptions options)

Public Function ExportNodes(
    options As OpcNodeExportOptions) As IEnumerable(Of OpcNodeSet)

Parameters

Name	Type	Description
options	OpcNodeExportOptions	The OpcNodeExportOptions to use or a null reference (Nothing in Visual Basic) to use the Default options.

Returns

IEnumerable<OpcNodeSet>

A sequence of OpcNodeSet instances, one per namespace of the node manager which contains nodes.

Remarks

The nodes are exported while the sequence is enumerated; the exception is thrown then as well. Nodes of a namespace which is not maintained by the node manager (see Namespaces) are not exported.

GetNode

2 overloads · since v2.15

Overload	Description
GetNode(string)since v2.15	Retrieves the IOpcNode which is maintained by the Nodes of this OpcNodeManager and is known under the nodePath specified.
GetNode(OpcNodeId)since v2.15	Retrieves the IOpcNode which is maintained by the Nodes of this OpcNodeManager and is known under the nodeId specified.

GetNode(string)

since v2.15

Retrieves the IOpcNode which is maintained by the Nodes of this OpcNodeManager and is known under the nodePath specified.

public IOpcNode GetNode(string nodePath)

Public Function GetNode(nodePath As String) As IOpcNode

Parameters

Name	Type	Description
nodePath	String	A sequence of browse and symbolic names combined using a slash ('/') to describe the 'path' to the node to determine. To query a node using its browse name use the namespace qualified name format 'namespaceIndex:name'; otherwise the 'part of the path' is compared to the symbolic name of the node.

Returns

IOpcNode

An instance implementing the IOpcNode interface its Name or SymbolicName matches the last 'part' in the nodePath specified, if found; otherwise a null reference (Nothing in Visual Basic).

Exceptions

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

Remarks

The first 'part' in the nodePath shall refer to a unique browse or symbolic name of a node maintained by the Nodes; otherwise the first node which matches the browse or symbolic name specified is used to continue the node query. Note that this method does not support querying nodes which are organized in an ambiguous way (according to their sub-tree they reside).

GetNode(OpcNodeId)

since v2.15

Retrieves the IOpcNode which is maintained by the Nodes of this OpcNodeManager and is known under the nodeId specified.

public IOpcNode GetNode(OpcNodeId nodeId)

Public Function GetNode(nodeId As OpcNodeId) As IOpcNode

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the IOpcNode instance to determine.

Returns

IOpcNode

An instance implementing the IOpcNode interface its Id attribute is equals to the nodeId specified if found; otherwise a null reference (Nothing in Visual Basic).

Exceptions

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

ImplementNode

protected · virtual · since v2.9

When implemented in a derived class, implements the logic required to integrate the node into the underlying system.

protected virtual void ImplementNode(IOpcNode node)

Protected Overridable Sub ImplementNode(node As IOpcNode)

Parameters

Name	Type	Description
node	IOpcNode	An instance implementing the IOpcNode interface which is to be integrated into the underlying system.

Remarks

This method is called during the whole address space creation. This includes the import of nodes using ImportNodes and the creation of nodes using CreateNodes. Each node imported / created is passed to this method to integrate it accordingly into the underlying system.

Additionally this method is called after the startup of the server whenever a client adds another node to the address space part(s) maintained by the current OpcNodeManager.

ImportNodes

protected · virtual · since v2.9

When implemented in a derived class, offers the different OpcNodeSets which are imported prior any other nodes are created within the address space part organized by the current OpcNodeManager.

protected virtual IEnumerable<OpcNodeSet> ImportNodes()

Protected Overridable Function ImportNodes() As IEnumerable(Of OpcNodeSet)

Returns

IEnumerable<OpcNodeSet>

A sequence of OpcNodeSet instances to use to import external stored node information into the address space.

IsNodeAccessible

protected · virtual · since v2.7

Determines whether the node specified is accessible in the context and view specified.

protected virtual bool IsNodeAccessible(
    OpcContext context,
    OpcNodeId viewId,
    IOpcNodeInfo node)

Protected Overridable Function IsNodeAccessible(
    context As OpcContext,
    viewId As OpcNodeId,
    node As IOpcNodeInfo) As Boolean

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the operation which accesses the node.
viewId	OpcNodeId	The OpcNodeId of the view to check or Null if the node is not accessed through a view.
node	IOpcNodeInfo	The IOpcNodeInfo of the node to check.

Returns

Boolean

The value true if the node is accessible; otherwise the value false. The base implementation evaluates IsAccessible and, for a variable node, requires an AccessLevel or UserAccessLevel other than None.

Exceptions

Exception	Condition
ArgumentNullException	The context, viewId or node is a null reference (Nothing in Visual Basic).

Remarks

The server treats a node which is not accessible like a node which does not exist.

IsNodeReadyToPublish

protected · since v2.50

Determines a value indicating whether any applied node changes are awaiting to be published by at least one monitored item.

protected bool IsNodeReadyToPublish(IOpcNode node)

Protected Function IsNodeReadyToPublish(node As IOpcNode) As Boolean

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode its publishing state is to be verified.

Returns

Boolean

The value true if the node has applied changes which are awaiting to be published; otherwise the value false.

Exceptions

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

OnAfterRead

protected · virtual

Raises the AfterRead event of the OpcNodeManager.

protected virtual void OnAfterRead(OpcNodeAccessEventArgs e)

Protected Overridable Sub OnAfterRead(e As OpcNodeAccessEventArgs)

Parameters

Name	Type	Description
e	OpcNodeAccessEventArgs	The event data.

OnAfterWrite

protected · virtual

Raises the AfterWrite event of the OpcNodeManager.

protected virtual void OnAfterWrite(OpcNodeAccessEventArgs e)

Protected Overridable Sub OnAfterWrite(e As OpcNodeAccessEventArgs)

Parameters

Name	Type	Description
e	OpcNodeAccessEventArgs	The event data.

OnBeforeRead

protected · virtual

Raises the BeforeRead event of the OpcNodeManager.

protected virtual void OnBeforeRead(OpcNodeAccessEventArgs e)

Protected Overridable Sub OnBeforeRead(e As OpcNodeAccessEventArgs)

Parameters

Name	Type	Description
e	OpcNodeAccessEventArgs	The event data.

OnBeforeWrite

protected · virtual

Raises the BeforeWrite event of the OpcNodeManager.

protected virtual void OnBeforeWrite(OpcNodeAccessEventArgs e)

Protected Overridable Sub OnBeforeWrite(e As OpcNodeAccessEventArgs)

Parameters

Name	Type	Description
e	OpcNodeAccessEventArgs	The event data.

OnMonitoredItemCreated

protected · virtual

Raises the MonitoredItemCreated event of the OpcNodeManager.

protected virtual void OnMonitoredItemCreated(OpcMonitoredItemEventArgs e)

Protected Overridable Sub OnMonitoredItemCreated(e As OpcMonitoredItemEventArgs)

Parameters

Name	Type	Description
e	OpcMonitoredItemEventArgs	The event data.

OnMonitoredItemDeleted

protected · virtual

Raises the MonitoredItemDeleted event of the OpcNodeManager.

protected virtual void OnMonitoredItemDeleted(OpcMonitoredItemEventArgs e)

Protected Overridable Sub OnMonitoredItemDeleted(e As OpcMonitoredItemEventArgs)

Parameters

Name	Type	Description
e	OpcMonitoredItemEventArgs	The event data.

OnMonitoredItemModified

protected · virtual

Raises the MonitoredItemModified event of the OpcNodeManager.

protected virtual void OnMonitoredItemModified(OpcMonitoredItemEventArgs e)

Protected Overridable Sub OnMonitoredItemModified(
    e As OpcMonitoredItemEventArgs)

Parameters

Name	Type	Description
e	OpcMonitoredItemEventArgs	The event data.

OnMonitoredItemsCreated

protected · virtual · since v2.7

Raises the MonitoredItemsCreated event of the OpcNodeManager.

protected virtual void OnMonitoredItemsCreated(OpcMonitoredItemsEventArgs e)

Protected Overridable Sub OnMonitoredItemsCreated(
    e As OpcMonitoredItemsEventArgs)

Parameters

Name	Type	Description
e	OpcMonitoredItemsEventArgs	The event data.

OnMonitoredItemsDeleted

protected · virtual · since v2.7

Raises the MonitoredItemsDeleted event of the OpcNodeManager.

protected virtual void OnMonitoredItemsDeleted(OpcMonitoredItemsEventArgs e)

Protected Overridable Sub OnMonitoredItemsDeleted(
    e As OpcMonitoredItemsEventArgs)

Parameters

Name	Type	Description
e	OpcMonitoredItemsEventArgs	The event data.

OnMonitoredItemsModified

protected · virtual · since v2.7

Raises the MonitoredItemsModified event of the OpcNodeManager.

protected virtual void OnMonitoredItemsModified(OpcMonitoredItemsEventArgs e)

Protected Overridable Sub OnMonitoredItemsModified(
    e As OpcMonitoredItemsEventArgs)

Parameters

Name	Type	Description
e	OpcMonitoredItemsEventArgs	The event data.

QueryNode

protected · virtual

When overridden in a derived class, provides the node with the nodeId specified which is not part of the Nodes.

protected virtual IOpcNode QueryNode(OpcNodeId nodeId)

Protected Overridable Function QueryNode(nodeId As OpcNodeId) As IOpcNode

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the node to provide.

Returns

IOpcNode

The IOpcNode with the nodeId specified, if known; otherwise a null reference (Nothing in Visual Basic). The base implementation returns a null reference.

Remarks

The method is called by GetNode and when the server looks up a node of the node manager which is not part of the Nodes.

Read

protected · virtual

Reads the attribute values requested by the tokens specified on behalf of a client.

protected virtual void Read(
    OpcContext context,
    OpcNodeAccessTokenCollection tokens)

Protected Overridable Sub Read(
    context As OpcContext,
    tokens As OpcNodeAccessTokenCollection)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the read operation.
tokens	OpcNodeAccessTokenCollection	The OpcNodeAccessTokenCollection with one OpcNodeAccessToken per attribute value to read, which receives the value and the result of the read.

Remarks

The method raises the BeforeRead event before and the AfterRead event after reading, also if reading fails.

ReadEventHistory

protected · virtual · since v2.54

Reads the history of the events of the node specified on behalf of a client.

protected virtual IEnumerable<OpcEvent> ReadEventHistory(
    OpcContext context,
    IOpcNode node,
    OpcEventFilter eventFilter,
    DateTime? startTime,
    DateTime? endTime,
    bool timeFlowsBackward,
    uint? maxCount)

Protected Overridable Function ReadEventHistory(
    context As OpcContext,
    node As IOpcNode,
    eventFilter As OpcEventFilter,
    startTime As Date?,
    endTime As Date?,
    timeFlowsBackward As Boolean,
    maxCount As UInteger?) As IEnumerable(Of OpcEvent)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the read operation.
node	IOpcNode	The IOpcNode whose event history is read.
eventFilter	OpcEventFilter	The OpcEventFilter which specifies the fields of the events to provide.
startTime	Nullable<DateTime>	The begin of the time range to read or a null reference (Nothing in Visual Basic) if the range is not limited at its begin.
endTime	Nullable<DateTime>	The end of the time range to read or a null reference (Nothing in Visual Basic) if the range is not limited at its end.
timeFlowsBackward	Boolean	The value true to provide the events in descending order of their timestamps; otherwise the value false.
maxCount	Nullable<UInt32>	The maximum number of events to provide or a null reference (Nothing in Visual Basic) if the number is not limited.

Returns

IEnumerable<OpcEvent>

A sequence of the OpcEvent instances read or a null reference (Nothing in Visual Basic) if RetrieveEventHistoryProvider provides no provider; in this case the client receives the code BadNotSupported for the node.

ReadHistory

protected · virtual · since v2.51

Reads the history of the values of the node specified on behalf of a client.

protected virtual IEnumerable<OpcHistoryValue> ReadHistory(
    OpcContext context,
    IOpcNode node,
    DateTime? startTime,
    DateTime? endTime,
    bool timeFlowsBackward,
    uint? maxCount,
    OpcReadHistoryOptions options)

Protected Overridable Function ReadHistory(
    context As OpcContext,
    node As IOpcNode,
    startTime As Date?,
    endTime As Date?,
    timeFlowsBackward As Boolean,
    maxCount As UInteger?,
    options As OpcReadHistoryOptions) As IEnumerable(Of OpcHistoryValue)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the read operation.
node	IOpcNode	The IOpcNode whose history is read.
startTime	Nullable<DateTime>	The begin of the time range to read or a null reference (Nothing in Visual Basic) if the range is not limited at its begin.
endTime	Nullable<DateTime>	The end of the time range to read or a null reference (Nothing in Visual Basic) if the range is not limited at its end.
timeFlowsBackward	Boolean	The value true to provide the values in descending order of their timestamps; otherwise the value false.
maxCount	Nullable<UInt32>	The maximum number of values to provide or a null reference (Nothing in Visual Basic) if the number is not limited.
options	OpcReadHistoryOptions	A combination of the OpcReadHistoryOptions flags which specify the values to provide.

Returns

IEnumerable<OpcHistoryValue>

A sequence of the OpcHistoryValue instances read or a null reference (Nothing in Visual Basic) if RetrieveNodeHistoryProvider provides no provider; in this case the client receives the code BadNotSupported for the node.

RemoveNode

4 overloads

Overload	Description
RemoveNode(IOpcNode)	Removes the node specified from the address space of the node manager.
RemoveNode(OpcContext, IOpcNode)since v2.7	Removes the node specified from the address space of the node manager using the context specified.
RemoveNode(IOpcNode, OpcLocalReferenceCollection)protected · since v2.7	Removes the node specified from the address space of the node manager and collects the references to remove from further node managers.
RemoveNode(OpcContext, IOpcNode, OpcLocalReferenceCollection)protected · virtual · since v2.7	Removes the node specified from the address space of the node manager using the context specified and collects the references to remove from further node managers.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The server using the node manager has not yet been started.

RemoveNode(IOpcNode)

Removes the node specified from the address space of the node manager.

public void RemoveNode(IOpcNode node)

Public Sub RemoveNode(node As IOpcNode)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode to remove.

Exceptions

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

Remarks

The references between the node and the nodes of other node managers are removed as well.

RemoveNode(OpcContext, IOpcNode)

since v2.7

Removes the node specified from the address space of the node manager using the context specified.

public void RemoveNode(OpcContext context, IOpcNode node)

Public Sub RemoveNode(context As OpcContext, node As IOpcNode)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to remove the node.
node	IOpcNode	The IOpcNode to remove.

Exceptions

Exception	Condition
ArgumentNullException	The context or node is a null reference (Nothing in Visual Basic).

Remarks

The references between the node and the nodes of other node managers are removed as well.

RemoveNode(IOpcNode, OpcLocalReferenceCollection)

protected · since v2.7

Removes the node specified from the address space of the node manager and collects the references to remove from further node managers.

protected void RemoveNode(IOpcNode node, OpcLocalReferenceCollection references)

Protected Sub RemoveNode(
    node As IOpcNode,
    references As OpcLocalReferenceCollection)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode to remove.
references	OpcLocalReferenceCollection	The OpcLocalReferenceCollection to which the references between the node and the nodes of other node managers are added.

Exceptions

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

Remarks

Unlike RemoveNode the method does not remove the collected references from the other node managers.

RemoveNode(OpcContext, IOpcNode, OpcLocalReferenceCollection)

protected · virtual · since v2.7

Removes the node specified from the address space of the node manager using the context specified and collects the references to remove from further node managers.

protected virtual void RemoveNode(
    OpcContext context,
    IOpcNode node,
    OpcLocalReferenceCollection references)

Protected Overridable Sub RemoveNode(
    context As OpcContext,
    node As IOpcNode,
    references As OpcLocalReferenceCollection)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to remove the node.
node	IOpcNode	The IOpcNode to remove.
references	OpcLocalReferenceCollection	The OpcLocalReferenceCollection to which the references between the node and the nodes of other node managers are added.

Exceptions

Exception	Condition
ArgumentNullException	The context or node is a null reference (Nothing in Visual Basic).

Remarks

The server calls the method also when it removes a node of the node manager. The method does not remove the collected references from the other node managers.

RemoveNotifierNode

protected

Removes the node from the collection of 'root' notifiers (= event sources) of the 'Server' node.

protected void RemoveNotifierNode(IOpcNode node)

Protected Sub RemoveNotifierNode(node As IOpcNode)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode instance acting as the notifier of the 'Server' node.

Exceptions

Exception	Condition
ArgumentNullException	The node is a null reference (Nothing in Visual Basic).
InvalidOperationException	The master node has not yet been created, therefore the operation is at the moment not available.

ReplaceHistory

protected · virtual

Replaces the history entries of the values specified of the node specified.

protected virtual OpcStatusCollection ReplaceHistory(
    IOpcNode node,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Protected Overridable Function ReplaceHistory(
    node As IOpcNode,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is changed.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values to replace the existing entries with.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value. If RetrieveNodeHistoryProvider provides no provider, each result has the code BadHistoryOperationUnsupported.

ReplaceNode

protected · since v2.9

Replaces an existing IOpcNode instance with the specified node without invalidating existing monitored items nor previously defined notifiers.

protected void ReplaceNode(IOpcNode node)

Protected Sub ReplaceNode(node As IOpcNode)

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode instance its Id is used to determine existing monitored items, notifiers and nodes to replace with the new one.

Exceptions

Exception	Condition
ArgumentNullException	The node is a null reference (Nothing in Visual Basic).
InvalidOperationException	The master node has not yet been created, therefore the operation is at the moment not available.

Remarks

To replace an existing node the OpcNodeId of the node specified needs to match the Id of an existing IOpcNode instance.

This method replaces an existing node and all of its children recursively in the Nodes of this OpcNodeManager and in the list of notifiers as well in the list of monitored items / nodes.

The caller of this method have to ensure that the node specified is as compatible to the previous node as the clients of the server expect. This includes for example the attributes or other metrics of a dedicated type of node to which a client may belong.

ReportEvent

7 overloads

Overload	Description
ReportEvent(OpcEventNode)	Produces a global event using the eventNode specified.
ReportEvent(OpcEventSeverity, OpcText)	Produces a global event using the event data specified.
ReportEvent(OpcEventSeverity, OpcText, params object[])	Produces a global event using the event data specified.
ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText)	Produces a global event using the event data specified.
ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText, params object[])	Produces a global event using the event data specified.
ReportEvent(IOpcNode, OpcEventSeverity, OpcText)	Produces a global event using the event data specified.
ReportEvent(IOpcNode, OpcEventSeverity, OpcText, params object[])	Produces a global event using the event data specified.

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The master node has not yet been created, therefore the operation is at the moment not available.
OpcException	The operation failed (see exception details for more information).

ReportEvent(OpcEventNode)

Produces a global event using the eventNode specified.

public void ReportEvent(OpcEventNode eventNode)

Public Sub ReportEvent(eventNode As OpcEventNode)

Parameters

Name	Type	Description
eventNode	OpcEventNode	The OpcEventNode its event information is to be reported as a global event.

Exceptions

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

ReportEvent(OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

public void ReportEvent(OpcEventSeverity severity, OpcText message)

Public Sub ReportEvent(severity As OpcEventSeverity, message As OpcText)

Parameters

Name	Type	Description
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event.

Exceptions

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

ReportEvent(OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

public void ReportEvent(
    OpcEventSeverity severity,
    OpcText message,
    params object[] arguments)

Public Sub ReportEvent(
    severity As OpcEventSeverity,
    message As OpcText,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event with format placeholders which where replaced with the arguments specified.
arguments	params Object[]	The values to place into the message using its format placeholders.

Exceptions

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

ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

public void ReportEvent(
    OpcNodeId sourceNodeId,
    string sourceName,
    OpcEventSeverity severity,
    OpcText message)

Public Sub ReportEvent(
    sourceNodeId As OpcNodeId,
    sourceName As String,
    severity As OpcEventSeverity,
    message As OpcText)

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which is to be used for the SourceNodeId property to define the origin of the event produced.
sourceName	String	The string which is to be used for the SourceName.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event.

Exceptions

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

ReportEvent(OpcNodeId, string, OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

public void ReportEvent(
    OpcNodeId sourceNodeId,
    string sourceName,
    OpcEventSeverity severity,
    OpcText message,
    params object[] arguments)

Public Sub ReportEvent(
    sourceNodeId As OpcNodeId,
    sourceName As String,
    severity As OpcEventSeverity,
    message As OpcText,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which is to be used for the SourceNodeId property to define the origin of the event produced.
sourceName	String	The string which is to be used for the SourceName.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event with format placeholders which where replaced with the arguments specified.
arguments	params Object[]	The values to place into the message using its format placeholders.

Exceptions

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

ReportEvent(IOpcNode, OpcEventSeverity, OpcText)

Produces a global event using the event data specified.

public void ReportEvent(
    IOpcNode source,
    OpcEventSeverity severity,
    OpcText message)

Public Sub ReportEvent(
    source As IOpcNode,
    severity As OpcEventSeverity,
    message As OpcText)

Parameters

Name	Type	Description
source	IOpcNode	The IOpcNode instance its Id is used for the SourceNodeId property and its SymbolicName is used for the SourceName property to define the origin of the event produced.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event.

Exceptions

Exception	Condition
ArgumentNullException	The source or message is a null reference (Nothing in Visual Basic).

ReportEvent(IOpcNode, OpcEventSeverity, OpcText, params object[])

Produces a global event using the event data specified.

public void ReportEvent(
    IOpcNode source,
    OpcEventSeverity severity,
    OpcText message,
    params object[] arguments)

Public Sub ReportEvent(
    source As IOpcNode,
    severity As OpcEventSeverity,
    message As OpcText,
    ParamArray arguments As Object())

Parameters

Name	Type	Description
source	IOpcNode	The IOpcNode instance its Id is used for the SourceNodeId property and its SymbolicName is used for the SourceName property to define the origin of the event produced.
severity	OpcEventSeverity	An indication of the urgency of the event.
message	OpcText	A human-readable and localizable text description of the event with format placeholders which where replaced with the arguments specified.
arguments	params Object[]	The values to place into the message using its format placeholders.

Exceptions

Exception	Condition
ArgumentNullException	The source or message is a null reference (Nothing in Visual Basic).

RetrieveEventHistoryProvider

protected · virtual · since v2.54

Retrieves the provider which provides the history of the events of the node specified.

protected virtual IOpcEventHistoryProvider RetrieveEventHistoryProvider(
    IOpcNode node)

Protected Overridable Function RetrieveEventHistoryProvider(
    node As IOpcNode) As IOpcEventHistoryProvider

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose event history is accessed.

Returns

IOpcEventHistoryProvider

The IOpcEventHistoryProvider to use or a null reference (Nothing in Visual Basic) if the event history of the node is not available. The base implementation returns the node if it implements IOpcEventHistoryProvider.

RetrieveNodeHistoryProvider

protected · virtual

Retrieves the provider which provides the history of the values of the node specified.

protected virtual IOpcNodeHistoryProvider RetrieveNodeHistoryProvider(
    IOpcNode node)

Protected Overridable Function RetrieveNodeHistoryProvider(
    node As IOpcNode) As IOpcNodeHistoryProvider

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is accessed.

Returns

IOpcNodeHistoryProvider

The IOpcNodeHistoryProvider to use or a null reference (Nothing in Visual Basic) if the history of the node is not available. The base implementation returns the node if it implements IOpcNodeHistoryProvider.

UpdateHistory

protected · virtual

Updates the history entries of the values specified of the node specified.

protected virtual OpcStatusCollection UpdateHistory(
    IOpcNode node,
    OpcHistoryModificationInfo modificationInfo,
    OpcValueCollection values)

Protected Overridable Function UpdateHistory(
    node As IOpcNode,
    modificationInfo As OpcHistoryModificationInfo,
    values As OpcValueCollection) As OpcStatusCollection

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode whose history is changed.
modificationInfo	OpcHistoryModificationInfo	The OpcHistoryModificationInfo which describes the modification.
values	OpcValueCollection	The OpcValueCollection with the values to create or to replace the existing entries with.

Returns

OpcStatusCollection

An OpcStatusCollection with the result per value. If RetrieveNodeHistoryProvider provides no provider, each result has the code BadHistoryOperationUnsupported.

Write

protected · virtual

Writes the attribute values provided by the tokens specified on behalf of a client.

protected virtual void Write(
    OpcContext context,
    OpcNodeAccessTokenCollection tokens)

Protected Overridable Sub Write(
    context As OpcContext,
    tokens As OpcNodeAccessTokenCollection)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext of the write operation.
tokens	OpcNodeAccessTokenCollection	The OpcNodeAccessTokenCollection with one OpcNodeAccessToken per attribute value to write, which receives the result of the write.

Remarks

The method raises the BeforeWrite event before and the AfterWrite event after writing, also if writing fails.

Events

AfterRead

Occurs after the node manager has read attribute values of its nodes on behalf of a client (see Read), also if reading has failed.

public event OpcNodeAccessEventHandler AfterRead

Public Event AfterRead As OpcNodeAccessEventHandler

Event type

OpcNodeAccessEventHandler

AfterWrite

Occurs after the node manager has written attribute values of its nodes on behalf of a client (see Write), also if writing has failed.

public event OpcNodeAccessEventHandler AfterWrite

Public Event AfterWrite As OpcNodeAccessEventHandler

Event type

OpcNodeAccessEventHandler

BeforeRead

Occurs before the node manager reads attribute values of its nodes on behalf of a client (see Read).

public event OpcNodeAccessEventHandler BeforeRead

Public Event BeforeRead As OpcNodeAccessEventHandler

Event type

OpcNodeAccessEventHandler

BeforeWrite

Occurs before the node manager writes attribute values of its nodes on behalf of a client (see Write).

public event OpcNodeAccessEventHandler BeforeWrite

Public Event BeforeWrite As OpcNodeAccessEventHandler

Event type

OpcNodeAccessEventHandler

MonitoredItemCreated

Occurs when a new monitored item is created through a OpcSession.

public event OpcMonitoredItemEventHandler MonitoredItemCreated

Public Event MonitoredItemCreated As OpcMonitoredItemEventHandler

Event type

OpcMonitoredItemEventHandler

MonitoredItemDeleted

Occurs when an existing monitored item of a OpcSession has been deleted.

public event OpcMonitoredItemEventHandler MonitoredItemDeleted

Public Event MonitoredItemDeleted As OpcMonitoredItemEventHandler

Event type

OpcMonitoredItemEventHandler

MonitoredItemModified

Occurs when an existing monitored item of a OpcSession has been modified.

public event OpcMonitoredItemEventHandler MonitoredItemModified

Public Event MonitoredItemModified As OpcMonitoredItemEventHandler

Event type

OpcMonitoredItemEventHandler

MonitoredItemsCreated

since v2.7

Occurs when a set of new monitored items is created through a OpcSession.

public event OpcMonitoredItemsEventHandler MonitoredItemsCreated

Public Event MonitoredItemsCreated As OpcMonitoredItemsEventHandler

Event type

OpcMonitoredItemsEventHandler

MonitoredItemsDeleted

since v2.7

Occurs when a set of existing monitored items of a OpcSession has been deleted.

public event OpcMonitoredItemsEventHandler MonitoredItemsDeleted

Public Event MonitoredItemsDeleted As OpcMonitoredItemsEventHandler

Event type

OpcMonitoredItemsEventHandler

MonitoredItemsModified

since v2.7

Occurs when a set of existing monitored items of a OpcSession has been modified.

public event OpcMonitoredItemsEventHandler MonitoredItemsModified

Public Event MonitoredItemsModified As OpcMonitoredItemsEventHandler

Event type

OpcMonitoredItemsEventHandler