APIs

Show:

Constructor

Reference

(
  • options.referenceType
  • options.nodeId
  • options.isForward
)

Parameters:

  • options.referenceType NodeId
  • options.nodeId NodeId
  • options.isForward Boolean

Methods

_addVariable

() private

_arrow

() private

Example:

  ---- some text ----->

_coerce_parent convert a 'string' , NodeId or Object into a valid and existing object

(
  • addressSpace
  • value
  • coerceFunc
)
private

Parameters:

  • addressSpace AddressSpace
  • value Object
  • coerceFunc Function

_createNode

(
  • options
)
BaseNode private

Parameters:

  • options Object
    • [nodeId] NodeId optional
    • nodeClass NodeClass
    • browseName String | QualifiedName

      the node browseName the browseName can be either a string : "Hello" a string with a namespace : "1:Hello" a QualifiedName : new QualifiedName({name:"Hello", namespaceIndex:1});

    • [displayName] String | LocalizedText optional

      the node display name

    • [description] String | LocalizedText optional

      the node description

Returns:

_process_modelling_rule

(
  • references
  • modellingRule
)
private

Parameters:

  • references Array

    the array of references

  • modellingRule Reference

    the modellling Rule reference.

addAlias

(
  • alias_name
  • nodeId
)

Parameters:

  • alias_name String

    the alias name

  • nodeId NodeId

    NodeId must belong to this namespace

addElement add a new element in a ExtensionObject Array variable

(
  • options
  • uaArrayVariableNode
  • nodeVariable
  • uaArrayVariableNode
  • constructor
  • uaArrayVariableNode
)
UAVariable

Parameters:

  • options Object

    data used to construct the underlying ExtensionObject

  • uaArrayVariableNode UAVariable
  • nodeVariable UAVariable

    a variable already exposing an extension objects

  • uaArrayVariableNode UAVariable
  • constructor Function

    constructor of the extension object to create

  • uaArrayVariableNode UAVariable

Returns:

addFolder

(
  • parentFolder
  • options
)
BaseNode

Parameters:

  • parentFolder Object
  • options String | Object
    • browseName String

      the name of the folder

    • [nodeId] NodeId optional

      . An optional nodeId for this object

Returns:

addObjectType

(
  • options
)

add a new Object type to the address space

Parameters:

  • options Object
    • browseName String

      the object type name

    • [displayName] String | LocalizedText optional

      the display name

    • [subtypeOf="BaseObjectType"] String | NodeId | BaseNode optional

      the base class

    • [nodeId] String | NodeId optional

      an optional nodeId for this objectType, if not provided a new nodeId will be created

    • [isAbstract= false] Boolean optional
    • [eventNotifier= 0] Integer optional
    • [postInstantiateFunc= null] Function optional

addReferenceType

(
  • options
)

Parameters:

  • options Object
    • isAbstract
    • browseName
    • inverseName

addVariable

(
  • options
)
Object

add a variable as a component of the parent node

Parameters:

  • options Object
    • browseName String

      the variable name

    • dataType String

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

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

      the Modelling rule : "Optional" , "Mandatory"

    • [valueRank= -1] Int optional

      the valueRank

    • [arrayDimensions] Null | Array optional

Returns:

Object:

addVariableType

(
  • options
)

add a new Variable type to the address space

Parameters:

  • options Object
    • browseName String

      the object type name

    • [displayName] String | LocalizedText optional

      the display name

    • [subtypeOf="BaseVariableType"] String | NodeId | BaseNode optional

      the base class

    • [nodeId] String | NodeId optional

      an optional nodeId for this objectType, if not provided a new nodeId will be created

    • [isAbstract= false] Boolean optional
    • dataType String | NodeId

      the variable DataType

    • [valueRank= -1] optional
    • [arrayDimensions= null] optional

      { Array>

bindExtObjArrayNode

(
  • uaArrayVariableNode
  • variableType
  • indexPropertyName
)
UAVariable

Parameters:

  • uaArrayVariableNode UAVariable
  • variableType DataType
  • indexPropertyName String

Returns:

checkSelectClause

(
  • parentNode
  • selectClause
)
Array

Parameters:

  • parentNode Object
  • selectClause Object

Returns:

Array:

checkSelectClauses

(
  • eventTypeNode
  • selectClauses
)
StatusCodes<>

Parameters:

  • eventTypeNode Object
  • selectClauses SelectClauseResults

Returns:

StatusCodes<>:

createDataType

(
  • options
)

Parameters:

  • options Object
    • isAbstract
    • browseName BrowseName
    • superType NodeId
    • [nodeId] optional
    • [displayName] optional
    • [description] optional

createExtObjArrayNode

(
  • parentFolder
  • options
)
Object | UAVariable

create a node Variable that contains a array of ExtensionObject of a given type

Parameters:

  • parentFolder Object
  • options Object
    • browseName
    • complexVariableType
    • variableType

      the type of Extension objects stored in the array.

    • indexPropertyName

Returns:

Object | UAVariable:

createNode

(
  • options
)

Parameters:

  • options Object
    • nodeClass
    • [nodeVersion= "0"] String optional

      install nodeVersion

    • [modellingRule= null] String optional

deleteNode

(
  • nodeOrNodeId
)

remove the specified Node from the address space

Parameters:

  • nodeOrNodeId Object

findReferenceTypeFromInverseName

(
  • inverseName
)
ReferenceType

find a ReferenceType by its inverse name.

Parameters:

  • inverseName String

    the inverse name of the ReferenceType to find

Returns:

makeOptionalsMap

(
  • optionals transform
)

Parameters:

  • optionals transform Object

    optional into a map

prepareDataType

(
  • dataType
)
private

Parameters:

  • dataType Object

removeElement

(
  • uaArrayVariableNode
  • elementIndex
  • uaArrayVariableNode
  • element
)

Parameters:

  • uaArrayVariableNode UAVariable
  • elementIndex Number

    index of element to remove in array

  • uaArrayVariableNode UAVariable
  • element UAVariable

    node of element to remove in array

toString

() String

turn reference into a arrow : ---- REFERENCETYPE --> [NODEID]

Returns:

String: