Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Optional historizingNodes

historizingNodes: {}

Type declaration

isFrugal

isFrugal: boolean

when this flag is set, properties and components are not added as javascript member of the UAObject/UAVariable node

rootFolder

rootFolder: { objects: UARootFolder_Objects; types: UAObject; views: UAObject }

Type declaration

Methods

browsePath

browseSingleNode

constructEventData

constructExtensionObject

deleteNode

dispose

  • dispose(): void

findCorrespondingBasicDataType

findDataType

findEventType

  • find an EventType node in the address space

    example
     const evtType = addressSpace.findEventType("AuditEventType");
    

    Parameters

    • eventTypeId: NodeIdLike | UAObjectType

      the eventType to find

    • Optional namespaceIndex: number

      an optional index to restrict the search in a given namespace

    Returns UAObjectType

    the EventType found or null.

    note:

    • the method with throw an exception if a node is found that is not a BaseEventType or a subtype of it.
    • if eventTypeId is of type NodeId, the namespaceIndex shall not be specified

findMethod

findNode

findObjectType

  • find an EventType node in the address space

    example
        const objectType = addressSpace.findObjectType("ns=0;i=58");
        objectType.browseName.toString().should.eql("BaseObjectType");
    
        const objectType = addressSpace.findObjectType("BaseObjectType");
        objectType.browseName.toString().should.eql("BaseObjectType");
    
        const objectType = addressSpace.findObjectType(resolveNodeId("ns=0;i=58"));
        objectType.browseName.toString().should.eql("BaseObjectType");
    
        const objectType = addressSpace.findObjectType("CustomObjectType",36);
        objectType.nodeId.namespace.should.eql(36);
        objectType.browseName.toString().should.eql("BaseObjectType");
    
        const objectType = addressSpace.findObjectType("36:CustomObjectType");
        objectType.nodeId.namespace.should.eql(36);
        objectType.browseName.toString().should.eql("BaseObjectType");
    

    Parameters

    • objectTypeId: NodeIdLike

      the eventType to find

    • Optional namespaceIndex: number

      an optional index to restrict the search in a given namespace

    Returns UAObjectType

    the EventType found or null.

    notes:

    • if objectTypeId is of type NodeId, the namespaceIndex shall not be specified

findReferenceType

findReferenceTypeFromInverseName

findVariableType

  • example
        const variableType = addressSpace.findVariableType("ns=0;i=62");
        variableType.browseName.toString().should.eql("BaseVariableType");
    
        const variableType = addressSpace.findVariableType("BaseVariableType");
        variableType.browseName.toString().should.eql("BaseVariableType");
    
        const variableType = addressSpace.findVariableType(resolveNodeId("ns=0;i=62"));
        variableType.browseName.toString().should.eql("BaseVariableType");
    

    Parameters

    • variableTypeId: NodeIdLike
    • Optional namespaceIndex: number

    Returns UAVariableType

generateEventId

getDefaultNamespace

getExtensionObjectConstructor

  • getExtensionObjectConstructor(dataType: NodeId | UADataType): AnyConstructable

getNamespace

  • getNamespace(indexOrName: string | number): INamespace

getNamespaceArray

getNamespaceIndex

  • getNamespaceIndex(namespaceUri: string): number

getNamespaceUri

  • getNamespaceUri(namespaceIndex: number): string

getOwnNamespace

installAlarmsAndConditionsService

  • installAlarmsAndConditionsService(): void

installHistoricalDataNode

inverseReferenceType

  • inverseReferenceType(referenceType: string): string

normalizeReferenceType

registerNamespace

  • registerNamespace(namespaceUri: string): INamespace

registerShutdownTask

  • registerShutdownTask(task: () => void): void

resolveNodeId

shutdown

  • shutdown(): void

Generated using TypeDoc