OpcNodeManager Members

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

C#

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

Parameters

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 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

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).

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

C#

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

Parameters

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 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

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).

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

C#

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

Parameters

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 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

ArgumentNullException

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

C#

public event OpcNodeAccessEventHandler AfterRead

C#

public event OpcNodeAccessEventHandler AfterWrite

C#

public event OpcNodeAccessEventHandler BeforeRead

C#

public event OpcNodeAccessEventHandler BeforeWrite

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

C#

public event OpcMonitoredItemEventHandler MonitoredItemCreated

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

C#

public event OpcMonitoredItemEventHandler MonitoredItemDeleted

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

C#

public event OpcMonitoredItemEventHandler MonitoredItemModified

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

C#

public event OpcMonitoredItemsEventHandler MonitoredItemsCreated

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

C#

public event OpcMonitoredItemsEventHandler MonitoredItemsDeleted

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

C#

public event OpcMonitoredItemsEventHandler MonitoredItemsModified

C#

public OpcNamespace DefaultNamespace { get; }

Property Value

OpcNamespace

C#

public int DefaultNamespaceIndex { get; }

Property Value

Int32

C#

public Uri DefaultNamespaceUri { get; }

Property Value

Uri

C#

public string DefaultNamespaceValue { get; }

Property Value

String

C#

public OpcReadOnlyNamespaceCollection Namespaces { get; }

Property Value

OpcReadOnlyNamespaceCollection

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.

C#

protected virtual OpcNodeIdFactory NodeIdFactory { get; set; }

Property Value

OpcNodeIdFactory

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

C#

public OpcReadOnlyNodeCollection Nodes { get; }

Property Value

OpcReadOnlyNodeCollection

C#

public OpcReadOnlyNodeCollection NotifierNodes { get; }

Property Value

OpcReadOnlyNodeCollection

C#

protected object SyncRoot { get; }

Property Value

Object

C#

protected OpcContext SystemContext { get; }

Property Value

OpcContext

C#

protected void AddNode(IOpcNode node)

Parameters

node IOpcNode

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

node IOpcNode

references IEnumerable<IOpcNodeReferenceAware>

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

node IOpcNode

references IOpcNodeReferenceAware[]

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

protected void AddNode(IOpcNode node, OpcNodeReferenceCollection references)

Parameters

node IOpcNode

references OpcNodeReferenceCollection

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

protected void AddNode(OpcContext context, IOpcNode node)

Parameters

context OpcContext

node IOpcNode

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

context OpcContext

node IOpcNode

references IEnumerable<IOpcNodeReferenceAware>

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

context OpcContext

node IOpcNode

references IOpcNodeReferenceAware[]

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

context OpcContext

node IOpcNode

references OpcNodeReferenceCollection

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

protected void AddNotifierNode(IOpcNode node)

Parameters

node IOpcNode

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

context OpcContext

browsePoint OpcBrowsePoint

references OpcReferenceDescriptionCollection

Returns

OpcBrowsePoint

C#

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

Parameters

node IOpcNode

modificationInfo OpcHistoryModificationInfo

values OpcValueCollection

Returns

OpcStatusCollection

C#

protected virtual IEnumerable<IOpcNode> CreateNodes(OpcNodeReferenceCollection references)

Parameters

references OpcNodeReferenceCollection

Returns

IEnumerable<IOpcNode>

C#

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

Parameters

node IOpcNode

modificationInfo OpcHistoryModificationInfo

times IEnumerable<DateTime>

Returns

OpcStatusCollection

C#

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

Parameters

node IOpcNode

modificationInfo OpcHistoryModificationInfo

startTime Nullable<DateTime>

endTime Nullable<DateTime>

options OpcDeleteHistoryOptions

Returns

OpcStatusCollection

C#

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

Parameters

node IOpcNode

modificationInfo OpcHistoryModificationInfo

values OpcValueCollection

Returns

OpcStatusCollection

C#

protected virtual void DeleteNodes()

Releases all resources used by the OpcNodeManager.

C#

public void Dispose()

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

C#

protected virtual void Dispose(bool disposing)

Parameters

disposing Boolean

The value true to release both managed and unmanaged resources; otherwise the value false to release only unmanaged resources.

C#

public IEnumerable<OpcNodeSet> ExportNodes()

Returns

IEnumerable<OpcNodeSet>

C#

public IEnumerable<OpcNodeSet> ExportNodes(OpcNodeExportOptions options)

Parameters

options OpcNodeExportOptions

Returns

IEnumerable<OpcNodeSet>

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

C#

public IOpcNode GetNode(OpcNodeId nodeId)

Parameters

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

ArgumentNullException

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

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

C#

public IOpcNode GetNode(string nodePath)

Parameters

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

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).

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

C#

protected virtual void ImplementNode(IOpcNode node)

Parameters

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(OpcNodeReferenceCollection). 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.

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.

C#

protected virtual IEnumerable<OpcNodeSet> ImportNodes()

Returns

IEnumerable<OpcNodeSet>

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

C#

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

Parameters

context OpcContext

viewId OpcNodeId

node IOpcNodeInfo

Returns

Boolean

Exceptions

ArgumentNullException

C#

protected virtual void OnAfterRead(OpcNodeAccessEventArgs e)

Parameters

e OpcNodeAccessEventArgs

C#

protected virtual void OnAfterWrite(OpcNodeAccessEventArgs e)

Parameters

e OpcNodeAccessEventArgs

C#

protected virtual void OnBeforeRead(OpcNodeAccessEventArgs e)

Parameters

e OpcNodeAccessEventArgs

C#

protected virtual void OnBeforeWrite(OpcNodeAccessEventArgs e)

Parameters

e OpcNodeAccessEventArgs

Raises the MonitoredItemCreated event of the OpcNodeManager.

C#

protected virtual void OnMonitoredItemCreated(OpcMonitoredItemEventArgs e)

Parameters

e OpcMonitoredItemEventArgs

The event data.

Raises the MonitoredItemDeleted event of the OpcNodeManager.

C#

protected virtual void OnMonitoredItemDeleted(OpcMonitoredItemEventArgs e)

Parameters

e OpcMonitoredItemEventArgs

The event data.

Raises the MonitoredItemModified event of the OpcNodeManager.

C#

protected virtual void OnMonitoredItemModified(OpcMonitoredItemEventArgs e)

Parameters

e OpcMonitoredItemEventArgs

The event data.

Raises the MonitoredItemsCreated event of the OpcNodeManager.

C#

protected virtual void OnMonitoredItemsCreated(OpcMonitoredItemsEventArgs e)

Parameters

e OpcMonitoredItemsEventArgs

The event data.

Raises the MonitoredItemsDeleted event of the OpcNodeManager.

C#

protected virtual void OnMonitoredItemsDeleted(OpcMonitoredItemsEventArgs e)

Parameters

e OpcMonitoredItemsEventArgs

The event data.

Raises the MonitoredItemsModified event of the OpcNodeManager.

C#

protected virtual void OnMonitoredItemsModified(OpcMonitoredItemsEventArgs e)

Parameters

e OpcMonitoredItemsEventArgs

The event data.

C#

protected virtual IOpcNode QueryNode(OpcNodeId nodeId)

Parameters

nodeId OpcNodeId

Returns

IOpcNode

C#

protected virtual void Read(OpcContext context, OpcNodeAccessTokenCollection tokens)

Parameters

context OpcContext

tokens OpcNodeAccessTokenCollection

C#

protected virtual IEnumerable<OpcHistoryValue> ReadHistory(IOpcNode node, DateTime? startTime, DateTime? endTime, OpcReadHistoryOptions options)

Parameters

node IOpcNode

startTime Nullable<DateTime>

endTime Nullable<DateTime>

options OpcReadHistoryOptions

Returns

IEnumerable<OpcHistoryValue>

C#

protected void RemoveNode(IOpcNode node)

Parameters

node IOpcNode

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

protected void RemoveNode(IOpcNode node, OpcLocalReferenceCollection references)

Parameters

node IOpcNode

references OpcLocalReferenceCollection

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

protected void RemoveNode(OpcContext context, IOpcNode node)

Parameters

context OpcContext

node IOpcNode

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

context OpcContext

node IOpcNode

references OpcLocalReferenceCollection

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

protected void RemoveNotifierNode(IOpcNode node)

Parameters

node IOpcNode

Exceptions

ArgumentNullException

InvalidOperationException

The master node has not yet been created, therefore the operation is at the moment not available.

C#

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

Parameters

node IOpcNode

modificationInfo OpcHistoryModificationInfo

values OpcValueCollection

Returns

OpcStatusCollection

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

C#

protected void ReplaceNode(IOpcNode node)

Parameters

node IOpcNode

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

Exceptions

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.

Produces a global event using the event data specified.

C#

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

Parameters

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

ArgumentNullException

The source or message 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.

OpcException

The operation failed (see exception details for more information).

Produces a global event using the event data specified.

C#

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

Parameters

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 Object[]

The values to place into the message using its format placeholders.

Exceptions

ArgumentNullException

The source or message 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.

OpcException

The operation failed (see exception details for more information).

Produces a global event using the eventNode specified.

C#

public void ReportEvent(OpcEventNode eventNode)

Parameters

eventNode OpcEventNode

The OpcEventNode its event information is to be reported as a global event.

Exceptions

ArgumentNullException

The eventNode 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.

OpcException

The operation failed (see exception details for more information).

Produces a global event using the event data specified.

C#

public void ReportEvent(OpcEventSeverity severity, OpcText message)

Parameters

severity OpcEventSeverity

An indication of the urgency of the event.

message OpcText

A human-readable and localizable text description of the event.

Exceptions

ArgumentNullException

The message 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.

OpcException

The operation failed (see exception details for more information).

Produces a global event using the event data specified.

C#

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

Parameters

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 Object[]

The values to place into the message using its format placeholders.

Exceptions

ArgumentNullException

The message 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.

OpcException

The operation failed (see exception details for more information).

Produces a global event using the event data specified.

C#

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

Parameters

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

ArgumentNullException

The message 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.

OpcException

The operation failed (see exception details for more information).

Produces a global event using the event data specified.

C#

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

Parameters

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 Object[]

The values to place into the message using its format placeholders.

Exceptions

ArgumentNullException

The message 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.

OpcException

The operation failed (see exception details for more information).

C#

protected virtual IOpcNodeHistoryProvider RetrieveNodeHistoryProvider(IOpcNode node)

Parameters

node IOpcNode

Returns

IOpcNodeHistoryProvider

C#

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

Parameters

node IOpcNode

modificationInfo OpcHistoryModificationInfo

values OpcValueCollection

Returns

OpcStatusCollection

C#

protected virtual void Write(OpcContext context, OpcNodeAccessTokenCollection tokens)

Parameters

context OpcContext

tokens OpcNodeAccessTokenCollection