API Docs for: 0.0.57
Show:

BaseNode Class

Base class for all address_space classes

Constructor

BaseNode

(
  • options
)

Parameters:

Methods

_clone

(
  • Constructor
  • options
  • extraInfo
)
private

Parameters:

  • Constructor Function
  • options Object
  • extraInfo 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:

addObjectInFolder

(
  • parentObject
  • options
)
Object deprecated

Parameters:

  • parentObject BaseNode | String | NodeId

    the parent folder (must be of type FolderType or a subtype of it)

  • options Object
    • [nodeId=null] NodeId optional

      the object nodeid.

    • [browseName=""] String optional

      the object browse name.

    • [description=""] String optional

      the object description.

    • eventNotifier Number

      the event notifier flag.

    • [typeDefinition="BaseObjectType"] optional

Returns:

Object:

addProperty

(
  • parent
  • options
  • options
)
Object deprecated

DEPRECATED : use this instead: addVariable({ propertyOf: parent }); add a variable as a property of the parent node

Parameters:

  • parent Object
  • options Object
  • options Object
    • String

      the variable name

    • String

      the variable datatype ( "Double", "UInt8" etc...)

    • [="BaseDataVariableType"] optional
    • [=null] optional

Returns:

Object:

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

(
  • strReference
  • [isForward=true]
)
Array

Parameters:

  • strReference String

    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
)
BaseNode | Null

retrieve a component by name

Parameters:

  • browseName Object

Returns:

BaseNode | Null:

getComponents

() BaseNode[]

Returns:

BaseNode[]:

return an array with the components of this object.

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.

getFolder

(
  • folder
)
UAObject deprecated

Parameters:

  • folder Object | String | NodeId

    the folder identifier either as an object, a nodeid string, or a NodeId.

Returns:

UAObject:

(ref(hasTypeDefinition)="FolderType")

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
)
UAMethod | Null

Parameters:

  • browseName Object

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
)
BaseNode | Null

retrieve a property by name

Parameters:

  • browseName Object

Returns:

BaseNode | Null:

getTrueSubStates

() BaseNode[]

Returns:

BaseNode[]:

return an array with the SubStates of this object.

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

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

Parameters:

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

Returns:

resolveNodeId

(
  • nodeId
)
NodeId

Parameters:

  • nodeId Object

Returns:

unpropagate_back_references

() private

Undo the effect of propagate_back_references

writeAttribute

(
  • writeValue
  • callback
)
async

Parameters:

  • 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

isFalseSubStateOf

BaseNode | Null

isTrueSubStateOf

BaseNode | Null

modellingRule

String | Undefined

namespaceIndex

Number

namespaceUri

String

parent

BaseNode

the parent node

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: