Reference

OpcReference Members

Type: OpcReference
Namespace: Opc.UaFx
Assembly: Opc.UaFx.Advanced.dll
Package: Opc.UaFx.Advanced v2.59.0
Also in: Opc.UaFx.Client

Constructors

OpcReference

4 overloads · since v2.7

Overload	Description
OpcReference(IOpcNode, OpcReferenceDirection, OpcReferenceType)since v2.7	Initializes a new instance of the OpcBidirectionalReference class using the `targetNode` as the target of the reference and using the value of the `type` parameter as the type of reference in the relation defined by `direction`.
OpcReference(IOpcNode, OpcReferenceDirection, OpcNodeId)since v2.7	Initializes a new instance of the OpcReference class using the `targetNode` as the target using the type of reference identified by the `typeId` specified in the relation defined by `direction`.
OpcReference(OpcNodeId, OpcReferenceDirection, OpcReferenceType)since v2.7	Initializes a new instance of the OpcBidirectionalReference class using the `targetNodeId` as the identifier of the target of the reference using the value of the `type` parameter as the type of the reference in the relation defined by `direction`.
OpcReference(OpcNodeId, OpcReferenceDirection, OpcNodeId)since v2.7	Initializes a new instance of the OpcBidirectionalReference class using the `targetNodeId` as the identifier of the target and using the type of reference identified by the `typeId` specified in the relation defined by `direction`.

OpcReference(IOpcNode, OpcReferenceDirection, OpcReferenceType)

since v2.7

Initializes a new instance of the OpcBidirectionalReference class using the targetNode as the target of the reference and using the value of the type parameter as the type of reference in the relation defined by direction.

csharp

public OpcReference(
    IOpcNode targetNode,
    OpcReferenceDirection direction,
    OpcReferenceType type)

vbnet

Public Sub New(
    targetNode As IOpcNode,
    direction As OpcReferenceDirection,
    type As OpcReferenceType)

Parameters

Name	Type	Description
`targetNode`	IOpcNode	The IOpcNodeInfo in which the reference constructed ceases.
`direction`	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference defines.
`type`	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented.

Exceptions

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

OpcReference(IOpcNode, OpcReferenceDirection, OpcNodeId)

since v2.7

Initializes a new instance of the OpcReference class using the targetNode as the target using the type of reference identified by the typeId specified in the relation defined by direction.

csharp

public OpcReference(
    IOpcNode targetNode,
    OpcReferenceDirection direction,
    OpcNodeId typeId)

vbnet

Public Sub New(
    targetNode As IOpcNode,
    direction As OpcReferenceDirection,
    typeId As OpcNodeId)

Parameters

Name	Type	Description
`targetNode`	IOpcNode	The IOpcNodeInfo in which the reference constructed ceases.
`direction`	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference defines.
`typeId`	OpcNodeId	The OpcNodeId which identifies the type of reference to represent between the `targetNode` and its opponent.

Exceptions

Exception	Condition
ArgumentNullException	The `targetNode` or `typeId` is a null reference (Nothing in Visual Basic).

OpcReference(OpcNodeId, OpcReferenceDirection, OpcReferenceType)

since v2.7

Initializes a new instance of the OpcBidirectionalReference class using the targetNodeId as the identifier of the target of the reference using the value of the type parameter as the type of the reference in the relation defined by direction.

csharp

public OpcReference(
    OpcNodeId targetNodeId,
    OpcReferenceDirection direction,
    OpcReferenceType type)

vbnet

Public Sub New(
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection,
    type As OpcReferenceType)

Parameters

Name	Type	Description
`targetNodeId`	OpcNodeId	The OpcNodeId which identifies the node in which the reference constructed ceases.
`direction`	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference defines.
`type`	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration to use to setup the type of reference represented.

Exceptions

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

OpcReference(OpcNodeId, OpcReferenceDirection, OpcNodeId)

since v2.7

Initializes a new instance of the OpcBidirectionalReference class using the targetNodeId as the identifier of the target and using the type of reference identified by the typeId specified in the relation defined by direction.

csharp

public OpcReference(
    OpcNodeId targetNodeId,
    OpcReferenceDirection direction,
    OpcNodeId typeId)

vbnet

Public Sub New(
    targetNodeId As OpcNodeId,
    direction As OpcReferenceDirection,
    typeId As OpcNodeId)

Parameters

Name	Type	Description
`targetNodeId`	OpcNodeId	The OpcNodeId which identifies the node in which the reference constructed ceases.
`direction`	OpcReferenceDirection	One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference defines.
`typeId`	OpcNodeId	The OpcNodeId which identifies the type of reference to represent between the target identified by the `targetNodeId` and its opponent.

Exceptions

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

Properties

Direction

Gets a value indicating the logical direction of the reference represented.

csharp

public OpcReferenceDirection Direction { get; }

vbnet

Public ReadOnly Property Direction As OpcReferenceDirection

Property value

OpcReferenceDirection

One of the members defined by the OpcReferenceDirection enumeration. The default value is ParentToChild.

TargetNode

since v2.7

Gets the node to which the reference refers to.

csharp

public IOpcNode TargetNode { get; }

vbnet

Public ReadOnly Property TargetNode As IOpcNode

Property value

IOpcNode

The IOpcNode to which the reference refers to or a null refernce (Nothing in Visual Basic) in case there this OpcReference has been initialized using a OpcNodeId which identifies the node the reference refers to.

TargetNodeId

since v2.7

Gets the identifier of the node to which the reference refers to.

csharp

public OpcNodeId TargetNodeId { get; }

vbnet

Public ReadOnly Property TargetNodeId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId which identifies the node to which the reference refers to.

Type

since v2.7

Gets a value which defines the pre-defined type of reference represented.

csharp

public OpcReferenceType? Type { get; }

vbnet

Public ReadOnly Property Type As OpcReferenceType?

Property value

Nullable<OpcReferenceType>

One of the members defined by the OpcReferenceType enumeration or a null reference (Nothing in Visual Basic) if TypeId refers to a type of reference which is not a built in reference type. The default value is Organizes.

TypeId

since v2.7

Gets the identifier which identifies the node that defines the semantic of the reference between the source and the target node represented through this OpcReference and generally reflects an operation between the two, such as "A contains B".

csharp

public OpcNodeId TypeId { get; }

vbnet

Public ReadOnly Property TypeId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the reference type node which defines the relation semantic between the source and the target node. The default value is Organizes.

Methods

GetReferences

3 overloads · since v2.7

Overload	Description
GetReferences()since v2.7	Retrieves an empty sequence of OpcNodeReference instances.
GetReferences(IOpcNode)since v2.7	Retrieves a sequence with one OpcNodeReference instance using the `node` specified as the source of the reference.
GetReferences(OpcNodeId)since v2.7	Retrieves a sequence with one OpcNodeReference instance using the `nodeId` specified as the source of the reference.

GetReferences()

since v2.7

Retrieves an empty sequence of OpcNodeReference instances.

csharp

public IEnumerable<OpcNodeReference> GetReferences()

vbnet

Public Function GetReferences() As IEnumerable(Of OpcNodeReference)

Returns

IEnumerable<OpcNodeReference>

An empty IEnumerable<T> of OpcNodeReference instances.

Implements

GetReferences

GetReferences(IOpcNode)

since v2.7

Retrieves a sequence with one OpcNodeReference instance using the node specified as the source of the reference.

csharp

public IEnumerable<OpcNodeReference> GetReferences(IOpcNode node)

vbnet

Public Function GetReferences(
    node As IOpcNode) As IEnumerable(Of OpcNodeReference)

Parameters

Name	Type	Description
`node`	IOpcNode	The IOpcNode instance from which the OpcNodeReference instance originates from.

Returns

IEnumerable<OpcNodeReference>

An IEnumerable<T> of OpcNodeReference instances which contains only one instance.

Exceptions

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

Implements

GetReferences

GetReferences(OpcNodeId)

since v2.7

Retrieves a sequence with one OpcNodeReference instance using the nodeId specified as the source of the reference.

csharp

public IEnumerable<OpcNodeReference> GetReferences(OpcNodeId nodeId)

vbnet

Public Function GetReferences(
    nodeId As OpcNodeId) As IEnumerable(Of OpcNodeReference)

Parameters

Name	Type	Description
`nodeId`	OpcNodeId	The OpcNodeId which identifies the node from which the OpcNodeReference instance originates from.

Returns

IEnumerable<OpcNodeReference>

An IEnumerable<T> of OpcNodeReference instances which contains only one instance.

Exceptions

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

Implements

GetReferences

ToString

override · since v2.7

Returns a string representing the information contained in the OpcReference.

csharp

public override string ToString()

vbnet

Public Overrides Function ToString() As String

Returns

String

A string which describes the information in this OpcReference.

Overrides

ToString()

OpcReference Members

OpcReference Members ​

Constructors ​

OpcReference ​

OpcReference(IOpcNode, OpcReferenceDirection, OpcReferenceType) ​

OpcReference(IOpcNode, OpcReferenceDirection, OpcNodeId) ​

OpcReference(OpcNodeId, OpcReferenceDirection, OpcReferenceType) ​

OpcReference(OpcNodeId, OpcReferenceDirection, OpcNodeId) ​

Properties ​

Direction ​

TargetNode ​

TargetNodeId ​

Type ​

TypeId ​

Methods ​

GetReferences ​

GetReferences() ​

GetReferences(IOpcNode) ​

GetReferences(OpcNodeId) ​

ToString ​

OpcReference Members

Constructors

OpcReference

OpcReference(IOpcNode, OpcReferenceDirection, OpcReferenceType)

OpcReference(IOpcNode, OpcReferenceDirection, OpcNodeId)

OpcReference(OpcNodeId, OpcReferenceDirection, OpcReferenceType)

OpcReference(OpcNodeId, OpcReferenceDirection, OpcNodeId)

Properties

Direction

TargetNode

TargetNodeId

Type

TypeId

Methods

GetReferences

GetReferences()

GetReferences(IOpcNode)

GetReferences(OpcNodeId)

ToString