Reference

OpcBidirectionalReference Members

Type

OpcBidirectionalReference

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcBidirectionalReference

4 overloads

Overload	Description
OpcBidirectionalReference(IOpcNode, OpcReferenceType)	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.
OpcBidirectionalReference(IOpcNode, OpcNodeId)	Initializes a new instance of the OpcBidirectionalReference class using the targetNode as the target using the type of reference identified by the typeId specified.
OpcBidirectionalReference(OpcNodeId, OpcReferenceType)	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.
OpcBidirectionalReference(OpcNodeId, OpcNodeId)	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.

OpcBidirectionalReference(IOpcNode, OpcReferenceType)

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.

public OpcBidirectionalReference(IOpcNode targetNode, OpcReferenceType type)

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

Parameters

Name	Type	Description
targetNode	IOpcNode	The IOpcNodeInfo in which the reference constructed ceases.
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).

OpcBidirectionalReference(IOpcNode, OpcNodeId)

Initializes a new instance of the OpcBidirectionalReference class using the targetNode as the target using the type of reference identified by the typeId specified.

public OpcBidirectionalReference(IOpcNode targetNode, OpcNodeId typeId)

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

Parameters

Name	Type	Description
targetNode	IOpcNode	The IOpcNodeInfo in which the reference constructed ceases.
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).

OpcBidirectionalReference(OpcNodeId, OpcReferenceType)

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.

public OpcBidirectionalReference(OpcNodeId targetNodeId, OpcReferenceType type)

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

Parameters

Name	Type	Description
targetNodeId	OpcNodeId	The OpcNodeId which identifies the node in which the reference constructed ceases.
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).

OpcBidirectionalReference(OpcNodeId, OpcNodeId)

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.

public OpcBidirectionalReference(OpcNodeId targetNodeId, OpcNodeId typeId)

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

Parameters

Name	Type	Description
targetNodeId	OpcNodeId	The OpcNodeId which identifies the node in which the reference constructed ceases.
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

TargetNode

Gets the node to which the reference refers to.

public IOpcNode TargetNode { get; }

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 OpcBidirectionalReference has been initialized using a OpcNodeId which identifies the node the reference refers to.

TargetNodeId

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

public OpcNodeId TargetNodeId { get; }

Public ReadOnly Property TargetNodeId As OpcNodeId

Property value

OpcNodeId

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

Type

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

public OpcReferenceType? Type { get; }

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

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

public OpcNodeId TypeId { get; }

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

Overload	Description
GetReferences()	Retrieves an empty sequence of OpcNodeReference instances.
GetReferences(IOpcNode)	Retrieves a sequence with two OpcNodeReference instances using the node specified as the source and target of the references.
GetReferences(OpcNodeId)	Retrieves a sequence with two OpcNodeReference instances using the nodeId specified as the source and target of the references.

GetReferences()

Retrieves an empty sequence of OpcNodeReference instances.

public IEnumerable<OpcNodeReference> GetReferences()

Public Function GetReferences() As IEnumerable(Of OpcNodeReference)

Returns

IEnumerable<OpcNodeReference>

An empty IEnumerable<T> of OpcNodeReference instances.

Implements

GetReferences

GetReferences(IOpcNode)

Retrieves a sequence with two OpcNodeReference instances using the node specified as the source and target of the references.

public IEnumerable<OpcNodeReference> GetReferences(IOpcNode node)

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

Parameters

Name	Type	Description
node	IOpcNode	The IOpcNode instance from which one OpcNodeReference instance will originate from and in which one will cease.

Returns

IEnumerable<OpcNodeReference>

An IEnumerable<T> of OpcNodeReference instances which contains two instances.

Exceptions

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

Implements

GetReferences

GetReferences(OpcNodeId)

Retrieves a sequence with two OpcNodeReference instances using the nodeId specified as the source and target of the references.

public IEnumerable<OpcNodeReference> GetReferences(OpcNodeId nodeId)

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

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId which identifies the node from which one OpcNodeReference instance will originate from and in which one will cease.

Returns

IEnumerable<OpcNodeReference>

An IEnumerable<T> of OpcNodeReference instances which contains two instances.

Exceptions

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

Implements

GetReferences

ToString

override

Returns a string representing the information contained in the OpcBidirectionalReference.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string which describes the information in this OpcBidirectionalReference.

Overrides

ToString()