APIs

Show:

The description of a reference.

Constructor

ReferenceDescription

(
  • options
)

Parameters:

  • options Object
    • [referenceTypeId] NodeId optional

      The type of references.

    • [isForward] Boolean optional

      TRUE if the reference is a forward reference.

    • [nodeId] ExpandedNodeId optional

      The id of the target node.

    • [browseName] QualifiedName optional

      The browse name of the target node.

    • [displayName] LocalizedText optional

      The display name of the target node.

    • [nodeClass= 0] NodeClass optional

      The node class of the target node.

    • [typeDefinition] ExpandedNodeId optional

      The type definition of the target node.

Methods

binaryStoreSize

() Number

Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode

(
  • stream
  • [option]
)

decode the object from a binary stream

Parameters:

encode

(
  • stream
)

encode the object into a binary stream

Parameters:

isValid

() Boolean

verify that all object attributes values are valid according to schema

Returns:

Boolean:

toString

() String

Returns:

String:

Properties

browseName

QualifiedName

The browse name of the target node.

displayName

LocalizedText

The display name of the target node.

isForward

Boolean

TRUE if the reference is a forward reference.

nodeClass

NodeClass

The node class of the target node.

Default: 0

typeDefinition

ExpandedNodeId

The type definition of the target node.