Reference

OpcNodeReferenceCollection Members

Type

OpcNodeReferenceCollection

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from KeyedCollection<OpcNodeId, OpcNodeReference>, Collection<OpcNodeReference>.

Constructors

OpcNodeReferenceCollection

Initializes a new instance of the OpcNodeReferenceCollection class.

public OpcNodeReferenceCollection()

Public Sub New()

Methods

Add

12 overloads

Overload	Description
Add(IOpcNode, OpcNodeId)	Adds OpcNodeReference instances representing a bidirectional relation between the sourceNode and the node identified by the targetNodeId specified.
Add(IOpcNode, OpcNodeId, OpcReferenceDirection?)since v2.7	Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the sourceNode and the target identified by the targetNodeId specified.
Add(IOpcNode, OpcNodeId, OpcReferenceDirection?, OpcReferenceType)since v2.7	Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the sourceNode and the target identified by the targetNodeId specified.
Add(IOpcNode, OpcNodeId, OpcReferenceDirection?, OpcNodeId)since v2.7	Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the sourceNode and the target identified by the targetNodeId specified.
Add(OpcNodeId, OpcNodeId)since v2.7	Adds OpcNodeReference instances representing a bidirectional relation between the source identified by the sourceNodeId and the node identified by the targetNodeId specified.
Add(OpcNodeId, OpcNodeId, OpcReferenceDirection?)since v2.7	Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the source identified by sourceNodeId and the target identified by the targetNodeId specified.
Add(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcReferenceType)since v2.7	Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId specified.
Add(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcNodeId)since v2.7	Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId specified.
Add(IOpcNode, IEnumerable<OpcReference>)since v2.7	Adds a OpcNodeReference instance representing a node / references bundle using the node and the references specified.
Add(IOpcNode, params OpcReference[])since v2.7	Adds a OpcNodeReference instance representing a node / references bundle using the node and the references specified.
Add(OpcNodeId, IEnumerable<OpcReference>)since v2.7	Adds a OpcNodeReference instance representing a node / references bundle using the node identified by the nodeId and the references specified.
Add(OpcNodeId, params OpcReference[])since v2.7	Adds a OpcNodeReference instance representing a node / references bundle using the node identified by the nodeId and the references specified.

Add(IOpcNode, OpcNodeId)

Adds OpcNodeReference instances representing a bidirectional relation between the sourceNode and the node identified by the targetNodeId specified. The references created represent a ParentToChild and ChildToParent relation using Organizes as the type of reference.

public OpcNodeReference[] Add(IOpcNode sourceNode, OpcNodeId targetNodeId)

Public Function Add(
    sourceNode As IOpcNode,
    targetNodeId As OpcNodeId) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNode	IOpcNode	The source portion of the bidirectional reference defined between the passed IOpcNode and the target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references added to the collection to define the bidirectional relation between the sourceNode and the target identified by the targetNodeId.

Exceptions

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

Add(IOpcNode, OpcNodeId, OpcReferenceDirection?)

since v2.7

Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the sourceNode and the target identified by the targetNodeId specified. The references created depend on the value specified by direction using Organizes as the type of reference.

public OpcNodeReference[] Add(
    IOpcNode sourceNode,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction)

Public Function Add(
    sourceNode As IOpcNode,
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection?) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNode	IOpcNode	The source portion of the references defined between the passed IOpcNode and target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round; if direction is a null reference (Nothing in Visual Basic).
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of unidirectional relation the reference will construct or a null reference (Nothing in Visual Basic) if bidirectional references shall be defined.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references addded to the collection to define the bidirectional or unidirectional relation between the sourceNode and the target identified by the targetNodeId.

Exceptions

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

Add(IOpcNode, OpcNodeId, OpcReferenceDirection?, OpcReferenceType)

since v2.7

Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the sourceNode and the target identified by the targetNodeId specified. The references created depend on the value specified by direction using the referenceType as the type of reference.

public OpcNodeReference[] Add(
    IOpcNode sourceNode,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction,
    OpcReferenceType referenceType)

Public Function Add(
    sourceNode As IOpcNode,
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection?,
    referenceType As OpcReferenceType) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNode	IOpcNode	The source portion of the references defined between the passed IOpcNode and target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round; if direction is a null reference (Nothing in Visual Basic).
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of unidirectional relation the reference will construct or a null reference (Nothing in Visual Basic) if bidirectional references shall be defined.
referenceType	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references addded to the collection to define the bidirectional or unidirectional relation between the sourceNode and the target identified by the targetNodeId.

Exceptions

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

Add(IOpcNode, OpcNodeId, OpcReferenceDirection?, OpcNodeId)

since v2.7

Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the sourceNode and the target identified by the targetNodeId specified. The references created depend on the value specified by direction using the type of reference identified by the referenceTypeId specified.

public OpcNodeReference[] Add(
    IOpcNode sourceNode,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction,
    OpcNodeId referenceTypeId)

Public Function Add(
    sourceNode As IOpcNode,
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection?,
    referenceTypeId As OpcNodeId) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNode	IOpcNode	The source portion of the references defined between the passed IOpcNode and target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round; if direction is a null reference (Nothing in Visual Basic).
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of unidirectional relation the reference will construct or a null reference (Nothing in Visual Basic) if bidirectional references shall be defined.
referenceTypeId	OpcNodeId	The OpcNodeId which identifies the type of reference to represent between the target identified by the targetNodeId and its opponent.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references addded to the collection to define the bidirectional or unidirectional relation between the sourceNode and the target identified by the targetNodeId.

Exceptions

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

Add(OpcNodeId, OpcNodeId)

since v2.7

Adds OpcNodeReference instances representing a bidirectional relation between the source identified by the sourceNodeId and the node identified by the targetNodeId specified. The references created represent a ParentToChild and ChildToParent relation using Organizes as the type of reference.

public OpcNodeReference[] Add(OpcNodeId sourceNodeId, OpcNodeId targetNodeId)

Public Function Add(
    sourceNodeId As OpcNodeId,
    targetNodeId As OpcNodeId) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which identifies the source portion of the bidirectional reference defined between the passed IOpcNode and the target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references added to the collection to define the bidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId.

Exceptions

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

Add(OpcNodeId, OpcNodeId, OpcReferenceDirection?)

since v2.7

Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the source identified by sourceNodeId and the target identified by the targetNodeId specified. The references created depend on the value specified by direction using Organizes as the type of reference.

public OpcNodeReference[] Add(
    OpcNodeId sourceNodeId,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction)

Public Function Add(
    sourceNodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection?) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which identifies the source portion of the references defined between the passed IOpcNode and target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round; if direction is a null reference (Nothing in Visual Basic).
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of unidirectional relation the reference will construct or a null reference (Nothing in Visual Basic) if bidirectional references shall be defined.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references addded to the collection to define the bidirectional or unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId.

Exceptions

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

Add(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcReferenceType)

since v2.7

Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId specified. The references created depend on the value specified by direction using the referenceType as the type of reference.

public OpcNodeReference[] Add(
    OpcNodeId sourceNodeId,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction,
    OpcReferenceType referenceType)

Public Function Add(
    sourceNodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection?,
    referenceType As OpcReferenceType) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which identifies the source portion of the references defined between the passed IOpcNode and target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round; if direction is a null reference (Nothing in Visual Basic).
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of unidirectional relation the reference will construct or a null reference (Nothing in Visual Basic) if bidirectional references shall be defined.
referenceType	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references addded to the collection to define the bidirectional or unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId.

Exceptions

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

Add(OpcNodeId, OpcNodeId, OpcReferenceDirection?, OpcNodeId)

since v2.7

Adds OpcNodeReference instances representing either a bidirectional or a unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId specified. The references created depend on the value specified by direction using the type of reference identified by the referenceTypeId specified.

public OpcNodeReference[] Add(
    OpcNodeId sourceNodeId,
    OpcNodeId targetNodeId,
    OpcReferenceDirection? direction,
    OpcNodeId referenceTypeId)

Public Function Add(
    sourceNodeId As OpcNodeId,
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection?,
    referenceTypeId As OpcNodeId) As OpcNodeReference()

Parameters

Name	Type	Description
sourceNodeId	OpcNodeId	The OpcNodeId which identifies the source portion of the references defined between the passed IOpcNode and target identified by the targetNodeId.
targetNodeId	OpcNodeId	The OpcNodeId which identifies the target one reference will cease in, while the second reference uses it the other way round; if direction is a null reference (Nothing in Visual Basic).
direction	Nullable<OpcReferenceDirection>	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of unidirectional relation the reference will construct or a null reference (Nothing in Visual Basic) if bidirectional references shall be defined.
referenceTypeId	OpcNodeId	The OpcNodeId which identifies the type of reference to represent between the target identified by the targetNodeId and its opponent.

Returns

OpcNodeReference[]

An array of OpcNodeReference instances representing the references addded to the collection to define the bidirectional or unidirectional relation between the source identified by the sourceNodeId and the target identified by the targetNodeId.

Exceptions

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

Add(IOpcNode, IEnumerable<OpcReference>)

since v2.7

Adds a OpcNodeReference instance representing a node / references bundle using the node and the references specified.

public OpcNodeReference Add(IOpcNode node, IEnumerable<OpcReference> references)

Public Function Add(
    node As IOpcNode,
    references As IEnumerable(Of OpcReference)) As OpcNodeReference

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode used as the node to which the references specified belong to.
references	IEnumerable<OpcReference>	A sequence of OpcReference instances to associate with the node refered to by node.

Returns

OpcNodeReference

A new instance of the OpcNodeReference class which combines the node and the references specified.

Exceptions

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

Add(IOpcNode, params OpcReference[])

since v2.7

Adds a OpcNodeReference instance representing a node / references bundle using the node and the references specified.

public OpcNodeReference Add(IOpcNode node, params OpcReference[] references)

Public Function Add(
    node As IOpcNode,
    ParamArray references As OpcReference()) As OpcNodeReference

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode used as the node to which the references specified belong to.
references	params OpcReference[]	An array of OpcReference instances to associate with the node refered to by node.

Returns

OpcNodeReference

A new instance of the OpcNodeReference class which combines the node and the references specified.

Exceptions

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

Add(OpcNodeId, IEnumerable<OpcReference>)

since v2.7

Adds a OpcNodeReference instance representing a node / references bundle using the node identified by the nodeId and the references specified.

public OpcNodeReference Add(
    OpcNodeId nodeId,
    IEnumerable<OpcReference> references)

Public Function Add(
    nodeId As OpcNodeId,
    references As IEnumerable(Of OpcReference)) As OpcNodeReference

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId which identifies the node to which the references specified belong to.
references	IEnumerable<OpcReference>	A sequence of OpcReference instances to associate with the node identified by the nodeId.

Returns

OpcNodeReference

A new instance of the OpcNodeReference class which combines the nodeId and the references specified.

Exceptions

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

Add(OpcNodeId, params OpcReference[])

since v2.7

Adds a OpcNodeReference instance representing a node / references bundle using the node identified by the nodeId and the references specified.

public OpcNodeReference Add(OpcNodeId nodeId, params OpcReference[] references)

Public Function Add(
    nodeId As OpcNodeId,
    ParamArray references As OpcReference()) As OpcNodeReference

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId which identifies the node to which the references specified belong to.
references	params OpcReference[]	An array of OpcReference instances to associate with the node identified by the nodeId.

Returns

OpcNodeReference

A new instance of the OpcNodeReference class which combines the nodeId and the references specified.

Exceptions

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

GetKeyForItem

protected · override

Extracts the key from the specified element.

protected override OpcNodeId GetKeyForItem(OpcNodeReference item)

Protected Overrides Function GetKeyForItem(
    item As OpcNodeReference) As OpcNodeId

Parameters

Name	Type	Description
item	OpcNodeReference	The item from which to extract the key.

Returns

OpcNodeId

The key for the specified item.

Exceptions

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

Overrides

GetKeyForItem(OpcNodeReference)