Reference
OpcNodeReference Members
Defines a bunch of OpcReference instances associated with a specific node using its IOpcNode instance or a OpcNodeId to identify the belonging node the references are used for.
Reference
OpcNodeReference Members
- Type
- OpcNodeReference
- Namespace
- Opc.UaFx
- Assembly
- Opc.UaFx.Advanced.dll
- Package
- Opc.UaFx.Advanced v2.59.0
- Also in
- Opc.UaFx.Client
Constructors
OpcNodeReference
| Overload | Description |
|---|---|
| OpcNodeReference( | Initializes a new instance of the OpcNodeReference class using the node specified. |
| OpcNodeReference( | Initializes a new instance of the OpcNodeReference class using the node and its references specified. |
| OpcNodeReference( | Initializes a new instance of the OpcNodeReference class using the node and its references specified. |
| OpcNodeReference( | Initializes a new instance of the OpcNodeReference class using the nodeId specified. |
| OpcNodeReference( | Initializes a new instance of the OpcNodeReference class using the nodeId and its node specific references specified. |
| OpcNodeReference( | Initializes a new instance of the OpcNodeReference class using the nodeId and its node specific references specified. |
OpcNodeReference(IOpcNode)
Initializes a new instance of the OpcNodeReference class using the node specified.
public OpcNodeReference(IOpcNode node)Public Sub New(node As IOpcNode)Parameters
| Name | Type | Description |
|---|---|---|
node | IOpcNode | The IOpcNode instance its references are organized by the new OpcNodeReference. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The node is a null reference ( |
OpcNodeReference(IOpcNode, IEnumerable<OpcReference>)
Initializes a new instance of the OpcNodeReference class using the node and its references specified.
public OpcNodeReference(IOpcNode node, IEnumerable<OpcReference> references)Public Sub New(node As IOpcNode, references As IEnumerable(Of OpcReference))Parameters
| Name | Type | Description |
|---|---|---|
node | IOpcNode | The IOpcNode instance its references are organized by the new OpcNodeReference. |
references | IEnumerable<OpcReference> | A sequence of OpcReference instances belonging to the node. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The node or references is a null reference ( |
OpcNodeReference(IOpcNode, params OpcReference[])
Initializes a new instance of the OpcNodeReference class using the node and its references specified.
public OpcNodeReference(IOpcNode node, params OpcReference[] references)Public Sub New(node As IOpcNode, ParamArray references As OpcReference())Parameters
| Name | Type | Description |
|---|---|---|
node | IOpcNode | The IOpcNode instance its references are organized by the new OpcNodeReference. |
references | params OpcReference[] | An array of OpcReference instances belonging to the node. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The node or references is a null reference ( |
OpcNodeReference(OpcNodeId)
Initializes a new instance of the OpcNodeReference class using the nodeId specified.
public OpcNodeReference(OpcNodeId nodeId)Public Sub New(nodeId As OpcNodeId)Parameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId which identifies the node its references are organized by the new OpcNodeReference. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The nodeId is a null reference ( |
OpcNodeReference(OpcNodeId, IEnumerable<OpcReference>)
Initializes a new instance of the OpcNodeReference class using the nodeId and its node specific references specified.
public OpcNodeReference(OpcNodeId nodeId, IEnumerable<OpcReference> references)Public Sub New(nodeId As OpcNodeId, references As IEnumerable(Of OpcReference))Parameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId which identifies the node its references are organized by the new OpcNodeReference. |
references | IEnumerable<OpcReference> | A sequence of OpcReference instances belonging to the nodeId. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The nodeId or references is a null reference ( |
OpcNodeReference(OpcNodeId, params OpcReference[])
Initializes a new instance of the OpcNodeReference class using the nodeId and its node specific references specified.
public OpcNodeReference(OpcNodeId nodeId, params OpcReference[] references)Public Sub New(nodeId As OpcNodeId, ParamArray references As OpcReference())Parameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId which identifies the node its references are organized by the new OpcNodeReference. |
references | params OpcReference[] | An array of OpcReference instances belonging to the nodeId. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The nodeId or references is a null reference ( |
Properties
Node
Gets the node to which the References belong to.
public IOpcNode Node { get; }Public ReadOnly Property Node As IOpcNodeProperty value
The IOpcNode which is used as the source node of the References or a null refernce (Nothing in Visual Basic) in case there this OpcNodeReference has been initialized using a OpcNodeId which identifies the node the References belong to.
NodeId
Gets the identifier of the node to which the References belong to.
public OpcNodeId NodeId { get; }Public ReadOnly Property NodeId As OpcNodeIdProperty value
The OpcNodeId which identifies the node to which the References belong to.
References
Gets a collection of OpcReference instances which belong the node identified by the NodeId or refered to in the Node property.
public OpcReferenceCollection References { get; }Public ReadOnly Property References As OpcReferenceCollectionProperty value
An instance of the OpcReferenceCollection class which contains the OpcReference instances which belong to the node its references are maintained by this OpcNodeReference.
Methods
From
| Overload | Description |
|---|---|
| From( | Provides a new OpcnodeId specified to construct OpcNodeReference instances using the nodeId as the identifier of the source node for the subsequent defined OpcNodeReference instances. |
| From( | Provides a new Opcnode specified to construct OpcNodeReference instances using the node as the source node for the subsequent defined OpcNodeReference instances. |
From(OpcNodeId)
Provides a new OpcNodeReferenceSource initialized with the nodeId specified to construct OpcNodeReference instances using the nodeId as the identifier of the source node for the subsequent defined OpcNodeReference instances.
public static OpcNodeReferenceSource From(OpcNodeId nodeId)Public Shared Function From(nodeId As OpcNodeId) As OpcNodeReferenceSourceParameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId which identifies the node from which the references constructed originate from. |
Returns
A new instance of the OpcNodeReferenceSource class initialized with the nodeId specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The nodeId is a null reference ( |
From(IOpcNode)
Provides a new OpcNodeReferenceSource initialized with the node specified to construct OpcNodeReference instances using the node as the source node for the subsequent defined OpcNodeReference instances.
public static OpcNodeReferenceSource From(IOpcNode node)Public Shared Function From(node As IOpcNode) As OpcNodeReferenceSourceParameters
| Name | Type | Description |
|---|---|---|
node | IOpcNode | The IOpcNode from which the references constructed originate from. |
Returns
A new instance of the OpcNodeReferenceSource class initialized with the node specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The node is a null reference ( |
To
| Overload | Description |
|---|---|
| To( | Provides a bidirectional reference using the targetNode as the target of the reference. |
| To( | Provides a bidirectional reference using the targetNode as the target of the reference. |
| To( | Provides a bidirectional reference using the targetNode as the target of the reference. |
| To( | Provides a bidirectional reference using the targetNodeId as the identifier of the target of the reference. |
| To( | Provides a bidirectional reference using the targetNodeId as the identifier of the target of the reference. |
| To( | Provides a bidirectional reference using the targetNodeId as the identifier of target of the reference. |
To(IOpcNode)
Provides a bidirectional reference using the targetNode as the target of the reference. The reference created represents a ParentToChild and ChildToParent relation using Organizes as the type of reference.
public static OpcBidirectionalReference To(IOpcNode targetNode)Public Shared Function [To](targetNode As IOpcNode) As OpcBidirectionalReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
Returns
A new instance of the OpcBidirectionalReference class initialized with the targetNode specified and setup using the Organizes in a bidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode is a null reference ( |
To(IOpcNode, OpcReferenceType)
Provides a bidirectional reference using the targetNode as the target of the reference. The reference created represents a ParentToChild and ChildToParent relation using the referenceType as the type of reference.
public static OpcBidirectionalReference To(
IOpcNode targetNode,
OpcReferenceType referenceType)Public Shared Function [To](
targetNode As IOpcNode,
referenceType As OpcReferenceType) As OpcBidirectionalReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
referenceType | OpcReferenceType | One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented. |
Returns
A new instance of the OpcBidirectionalReference class initialized with the targetNode specified and setup using the referenceType passed in a bidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode is a null reference ( |
To(IOpcNode, OpcNodeId)
Provides a bidirectional reference using the targetNode as the target of the reference. The reference created represents a ParentToChild and ChildToParent relation using the type of reference identified by the referenceTypeId specified.
public static OpcBidirectionalReference To(
IOpcNode targetNode,
OpcNodeId referenceTypeId)Public Shared Function [To](
targetNode As IOpcNode,
referenceTypeId As OpcNodeId) As OpcBidirectionalReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
referenceTypeId | OpcNodeId | The OpcNodeId which identifies the type of reference to represent between the targetNode and its opponent. |
Returns
A new instance of the OpcBidirectionalReference class initialized with the targetNode specified and setup using the referenceTypeId passed in a bidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode or referenceTypeId is a null reference ( |
To(OpcNodeId)
Provides a bidirectional reference using the targetNodeId as the identifier of the target of the reference. The reference created represents a ParentToChild and ChildToParent relation using Organizes as the type of reference.
public static OpcBidirectionalReference To(OpcNodeId targetNodeId)Public Shared Function [To](
targetNodeId As OpcNodeId) As OpcBidirectionalReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
Returns
A new instance of the OpcBidirectionalReference class initialized with the targetNodeId specified and setup using the Organizes in a bidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId is a null reference ( |
To(OpcNodeId, OpcReferenceType)
Provides a bidirectional reference using the targetNodeId as the identifier of the target of the reference. The reference created represents a ParentToChild and ChildToParent relation using the referenceType as the type of reference.
public static OpcBidirectionalReference To(
OpcNodeId targetNodeId,
OpcReferenceType referenceType)Public Shared Function [To](
targetNodeId As OpcNodeId,
referenceType As OpcReferenceType) As OpcBidirectionalReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
referenceType | OpcReferenceType | One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented. |
Returns
A new instance of the OpcBidirectionalReference class initialized with the targetNodeId specified and setup using the referenceType passed in a bidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId is a null reference ( |
To(OpcNodeId, OpcNodeId)
Provides a bidirectional reference using the targetNodeId as the identifier of target of the reference. The reference created represents a ParentToChild and ChildToParent relation using the type of reference identified by the referenceTypeId specified.
public static OpcBidirectionalReference To(
OpcNodeId targetNodeId,
OpcNodeId referenceTypeId)Public Shared Function [To](
targetNodeId As OpcNodeId,
referenceTypeId As OpcNodeId) As OpcBidirectionalReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
referenceTypeId | OpcNodeId | The OpcNodeId which identifies the type of reference to represent between the target identified by the targetNodeId and its opponent. |
Returns
A new instance of the OpcBidirectionalReference class initialized with the targetNodeId specified and setup using the referenceTypeId passed in a bidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId or referenceTypeId is a null reference ( |
ToChild
| Overload | Description |
|---|---|
| ToChild( | Provides a unidirectional reference using the targetNode as the target of the reference. |
| ToChild( | Provides a unidirectional reference using the targetNode as the target of the reference. |
| ToChild( | Provides a unidirectional reference using the targetNode as the target of the reference. |
| ToChild( | Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. |
| ToChild( | Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. |
| ToChild( | Provides a unidirectional reference using the targetNodeId as the identifier of target of the reference. |
ToChild(IOpcNode)
Provides a unidirectional reference using the targetNode as the target of the reference. The reference created represents a ParentToChild relation using Organizes as the type of reference.
public static OpcReference ToChild(IOpcNode targetNode)Public Shared Function ToChild(targetNode As IOpcNode) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
Returns
A new instance of the OpcReference class initialized with the targetNode specified and setup using the Organizes in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode is a null reference ( |
ToChild(IOpcNode, OpcReferenceType)
Provides a unidirectional reference using the targetNode as the target of the reference. The reference created represents a ParentToChild relation using the referenceType as the type of reference.
public static OpcReference ToChild(
IOpcNode targetNode,
OpcReferenceType referenceType)Public Shared Function ToChild(
targetNode As IOpcNode,
referenceType As OpcReferenceType) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
referenceType | OpcReferenceType | One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented. |
Returns
A new instance of the OpcReference class initialized with the targetNode specified and setup using the referenceType passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode is a null reference ( |
ToChild(IOpcNode, OpcNodeId)
Provides a unidirectional reference using the targetNode as the target of the reference. The reference created represents a ParentToChild relation using the type of reference identified by the referenceTypeId specified.
public static OpcReference ToChild(
IOpcNode targetNode,
OpcNodeId referenceTypeId)Public Shared Function ToChild(
targetNode As IOpcNode,
referenceTypeId As OpcNodeId) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
referenceTypeId | OpcNodeId | The OpcNodeId which identifies the type of reference to represent between the targetNode and its opponent. |
Returns
A new instance of the OpcReference class initialized with the targetNode specified and setup using the referenceTypeId passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode or referenceTypeId is a null reference ( |
ToChild(OpcNodeId)
Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. The reference created represents a ParentToChild relation using Organizes as the type of reference.
public static OpcReference ToChild(OpcNodeId targetNodeId)Public Shared Function ToChild(targetNodeId As OpcNodeId) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
Returns
A new instance of the OpcReference class initialized with the targetNodeId specified and setup using the Organizes in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId is a null reference ( |
ToChild(OpcNodeId, OpcReferenceType)
Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. The reference created represents a ParentToChild relation using the referenceType as the type of reference.
public static OpcReference ToChild(
OpcNodeId targetNodeId,
OpcReferenceType referenceType)Public Shared Function ToChild(
targetNodeId As OpcNodeId,
referenceType As OpcReferenceType) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
referenceType | OpcReferenceType | One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented. |
Returns
A new instance of the OpcReference class initialized with the targetNodeId specified and setup using the referenceType passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId is a null reference ( |
ToChild(OpcNodeId, OpcNodeId)
Provides a unidirectional reference using the targetNodeId as the identifier of target of the reference. The reference created represents a ParentToChild relation using the type of reference identified by the referenceTypeId specified.
public static OpcReference ToChild(
OpcNodeId targetNodeId,
OpcNodeId referenceTypeId)Public Shared Function ToChild(
targetNodeId As OpcNodeId,
referenceTypeId As OpcNodeId) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
referenceTypeId | OpcNodeId | The OpcNodeId which identifies the type of reference to represent between the target identified by the targetNodeId and its opponent. |
Returns
A new instance of the OpcReference class initialized with the targetNodeId specified and setup using the referenceTypeId passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId or referenceTypeId is a null reference ( |
ToParent
| Overload | Description |
|---|---|
| ToParent( | Provides a unidirectional reference using the targetNode as the target of the reference. |
| ToParent( | Provides a unidirectional reference using the targetNode as the target of the reference. |
| ToParent( | Provides a unidirectional reference using the targetNode as the target of the reference. |
| ToParent( | Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. |
| ToParent( | Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. |
| ToParent( | Provides a unidirectional reference using the targetNodeId as the identifier of target of the reference. |
ToParent(IOpcNode)
Provides a unidirectional reference using the targetNode as the target of the reference. The reference created represents a ChildToParent relation using Organizes as the type of reference.
public static OpcReference ToParent(IOpcNode targetNode)Public Shared Function ToParent(targetNode As IOpcNode) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
Returns
A new instance of the OpcReference class initialized with the targetNode specified and setup using the Organizes in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode is a null reference ( |
ToParent(IOpcNode, OpcReferenceType)
Provides a unidirectional reference using the targetNode as the target of the reference. The reference created represents a ChildToParent relation using the referenceType as the type of reference.
public static OpcReference ToParent(
IOpcNode targetNode,
OpcReferenceType referenceType)Public Shared Function ToParent(
targetNode As IOpcNode,
referenceType As OpcReferenceType) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
referenceType | OpcReferenceType | One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented. |
Returns
A new instance of the OpcReference class initialized with the targetNode specified and setup using the referenceType passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode is a null reference ( |
ToParent(IOpcNode, OpcNodeId)
Provides a unidirectional reference using the targetNode as the target of the reference. The reference created represents a ChildToParent relation using the type of reference identified by the referenceTypeId specified.
public static OpcReference ToParent(
IOpcNode targetNode,
OpcNodeId referenceTypeId)Public Shared Function ToParent(
targetNode As IOpcNode,
referenceTypeId As OpcNodeId) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNode | IOpcNode | The IOpcNode in which the reference constructed ceases. |
referenceTypeId | OpcNodeId | The OpcNodeId which identifies the type of reference to represent between the targetNode and its opponent. |
Returns
A new instance of the OpcReference class initialized with the targetNode specified and setup using the referenceTypeId passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNode or referenceTypeId is a null reference ( |
ToParent(OpcNodeId)
Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. The reference created represents a ChildToParent relation using Organizes as the type of reference.
public static OpcReference ToParent(OpcNodeId targetNodeId)Public Shared Function ToParent(targetNodeId As OpcNodeId) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
Returns
A new instance of the OpcReference class initialized with the targetNodeId specified and setup using the Organizes in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId is a null reference ( |
ToParent(OpcNodeId, OpcReferenceType)
Provides a unidirectional reference using the targetNodeId as the identifier of the target of the reference. The reference created represents a ChildToParent relation using the referenceType as the type of reference.
public static OpcReference ToParent(
OpcNodeId targetNodeId,
OpcReferenceType referenceType)Public Shared Function ToParent(
targetNodeId As OpcNodeId,
referenceType As OpcReferenceType) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
referenceType | OpcReferenceType | One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented. |
Returns
A new instance of the OpcReference class initialized with the targetNodeId specified and setup using the referenceType passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId is a null reference ( |
ToParent(OpcNodeId, OpcNodeId)
Provides a unidirectional reference using the targetNodeId as the identifier of target of the reference. The reference created represents a ChildToParent relation using the type of reference identified by the referenceTypeId specified.
public static OpcReference ToParent(
OpcNodeId targetNodeId,
OpcNodeId referenceTypeId)Public Shared Function ToParent(
targetNodeId As OpcNodeId,
referenceTypeId As OpcNodeId) As OpcReferenceParameters
| Name | Type | Description |
|---|---|---|
targetNodeId | OpcNodeId | The OpcNodeId which identifies the node in which the reference constructed ceases. |
referenceTypeId | OpcNodeId | The OpcNodeId which identifies the type of reference to represent between the target identified by the targetNodeId and its opponent. |
Returns
A new instance of the OpcReference class initialized with the targetNodeId specified and setup using the referenceTypeId passed in a unidirectional manner.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The targetNodeId or referenceTypeId is a null reference ( |
ToString
Returns a string representing the information contained in the OpcNodeReference.
public override string ToString()Public Overrides Function ToString() As StringReturns
A string which describes the information in this OpcNodeReference.
Overrides

