APIs

Show:

Base class for all address_space classes

BaseNode is the base class for all the OPCUA objects in the address space It provides attributes and a set of references to other nodes. see: UAObject, UAVariable, Reference, UAMethod, UAView, UAObjecType, UADataType, UAVariableType,

Constructor

BaseNode

(
  • options
)

Parameters:

Methods

_clone

(
  • Constructor
  • options
  • extraInfo
  • optionalFilter
)
private

Parameters:

  • Constructor Function
  • options Object
  • extraInfo Object
  • optionalFilter Object

Returns:

:

_clone_children_references

(
  • newParent
  • [optionalFilter = null]
  • [extraInfo]
)
Array private

clone properties and methods

Parameters:

  • newParent Object

    the new parent object to which references of type HasChild will be attached

  • [optionalFilter = null] Function optional

    a filter

  • [extraInfo] Object optional

Returns:

Array:

addReference

(
  • reference
)

Parameters:

  • reference Object
    • referenceType String
    • [isForward= true] Boolean optional
    • nodeId Node | NodeId | String

Example:

view.addReference({ referenceType: "Organizes", nodeId: myDevice });
                    

or

myDevice1.addReference({ referenceType: "OrganizedBy", nodeId: view });

browseNode

(
  • browseDescription
  • session
)
ReferenceDescription[]

browse the node to extract information requested in browseDescription

Parameters:

browseNodeByTargetName

(
  • relativePathElement
)
NodeId[]

Parameters:

Returns:

dispose

()

the dispose method should be called when the node is no longer used, to release back pointer to the address space and clear caches.

dumpReferences

(
  • addressSpace
  • references
)
static

Parameters:

findReference

(
  • strReference
  • [isForward]
  • [optionalSymbolicName]
)
Reference

Parameters:

  • strReference String

    the referenceType as a string.

  • [isForward] Boolean | Null optional
  • [optionalSymbolicName] String optional

Returns:

findReferences

(
  • referenceType
  • [isForward=true]
)
Array

Parameters:

  • referenceType String | NodeId | ReferenceType

    the referenceType as a string.

  • [isForward=true] Boolean optional

Returns:

Array:

full_name

() String

Returns:

String:

the full path name of the node

getAggregates

() BaseNode[]

Returns:

BaseNode[]:

return an array with the Aggregates of this object.

getComponentByName

(
  • browseName
  • [namespaceIndex=null]
)
BaseNode | Null

retrieve a component by name

Parameters:

  • browseName Object
  • [namespaceIndex=null] Object optional

Returns:

BaseNode | Null:

getComponents

() BaseNode[]

Returns:

BaseNode[]:

return an array with the components of this object.

getEventSourceOfs

() BaseNode[]

Returns:

BaseNode[]:

return a array of the objects for which this node is an EventSource

getEventSources

() BaseNode[]

Returns:

BaseNode[]:

return a array with the event source of this object.

getFalseSubStates

() BaseNode[]

Returns:

BaseNode[]:

return an array with the SubStates of this object.

getFolderElements

() Array

returns the list of nodes that this folder object organizes

Returns:

Array:

getMethodById

(
  • nodeId
)
UAMethod | Null

Parameters:

  • nodeId Object

Returns:

UAMethod | Null:

getMethodByName

(
  • browseName
  • [namespaceIndex=null]
)
UAMethod | Null

Parameters:

  • browseName Object
  • [namespaceIndex=null] Object optional

Returns:

UAMethod | Null:

getMethods

() Array

returns the list of methods that this object provides

Returns:

Array:

returns an array wit"h Method objects.

Note: internally, methods are special types of components

getNotifiers

() BaseNode[]

Returns:

BaseNode[]:

return a array with the notifiers of this object.

getProperties

() BaseNode[]

Returns:

BaseNode[]:

return a array with the properties of this object.

getPropertyByName

(
  • browseName
  • [namespaceIndex=null]
)
BaseNode | Null

retrieve a folder by name

Parameters:

  • browseName Object
  • [namespaceIndex=null] Object optional

Returns:

BaseNode | Null:

getPropertyByName

(
  • browseName
  • [namespaceIndex=null]
)
BaseNode | Null

retrieve a property by name

Parameters:

  • browseName Object
  • [namespaceIndex=null] Object optional

Returns:

BaseNode | Null:

getTrueSubStates

() BaseNode[]

Returns:

BaseNode[]:

return an array with the SubStates of this object.

isArgumentValid

(
  • addressSpace
  • argDefinition
  • arg
)
Boolean private

Parameters:

Returns:

Boolean:

normalize_referenceTypeId

(
  • addressSpace
  • referenceTypeId
)
NodeId

Parameters:

  • addressSpace AddressSpace
  • referenceTypeId String | NodeId | Null

    : the referenceType either as a string or a nodeId

Returns:

propagate_back_references

()

this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

readAttribute

(
  • context
  • attributeId
  • [indexRange]
  • [dataEncoding]
)
DataValue

Parameters:

  • context SessionContext
  • attributeId AttributeId
  • [indexRange] NumericRange optional
  • [dataEncoding] String optional

Returns:

removeReference

(
  • reference
)

Parameters:

  • reference Object

Returns:

void

resolveNodeId

(
  • nodeId
)
NodeId

Parameters:

  • nodeId Object

Returns:

unpropagate_back_references

() private

Undo the effect of propagate_back_references

verifyArguments_ArgumentList

(
  • addressSpace
  • methodInputArguments
  • inputArguments
)

Parameters:

Returns:

statusCode,inputArgumentResults

writeAttribute

(
  • context
  • writeValue
  • callback
)
async

Parameters:

  • context SessionContext
  • writeValue Object
    • attributeId AttributeId
    • dataValue DataValue
    • indexRange NumericRange
  • callback Function

Properties

browseName

QualifiedName static

the node browseName

hasMethods

Boolean

returns true if the object has some opcua methods

modellingRule

String | Undefined

subtypeOf

NodeId

returns the nodeId of the Type which is the super type of this

typeDefinition

NodeId

returns the nodeId of this node's Type Definition

typeDefinitionObj

BaseNode

returns the nodeId of this node's Type Definition

Events

Description_changed

fires when the description attribute is changed.

Event Payload:

DisplayName_changed

fires when the displayName is changed.

Event Payload: