Class AddressSpace

OptionalhistorizingNodes

isFrugal

addMethodCallInterceptor

• addMethodCallInterceptor(interceptor: MethodCallInterceptor): void

  Register a method call interceptor. Interceptors are called sequentially before each UAMethod.execute(). If any interceptor returns a non-Good StatusCode, the method call is rejected and subsequent interceptors are skipped.

  Parameters

  • interceptor: MethodCallInterceptor

  Returns void

browsePath

• browsePath(browsePath: BrowsePath): BrowsePathResult

  Parameters

  • browsePath: BrowsePath

  Returns BrowsePathResult

browseSingleNode

• browseSingleNode(
      nodeId: NodeIdLike,
      browseDescription: BrowseDescription,
      context?: ISessionContext,
  ): BrowseResult

  Parameters

  • nodeId: NodeIdLike
  • browseDescription: BrowseDescription
  • Optionalcontext: ISessionContext

  Returns BrowseResult

constructEventData

• constructEventData(
      eventTypeId: UAEventType,
      data: Record<string, unknown>,
  ): IEventData

  construct a simple javascript object with all the default properties of the event

  eventTypeId can be a UAObjectType deriving from EventType or an instance of a ConditionType

  Parameters

  • eventTypeId: UAEventType
  • data: Record<string, unknown>

  Returns IEventData

constructExtensionObject

• constructExtensionObject(
      dataType: NodeId | UADataType,
      options?: Record<string, unknown>,
  ): ExtensionObject

  construct an extension object constructor from a DataType nodeID or UADataType object

  Parameters

  • dataType: NodeId | UADataType
  • Optionaloptions: Record<string, unknown>

  Returns ExtensionObject

deleteNode

• deleteNode(node: NodeId | BaseNode<BaseNodeEvents>): void

  Parameters

  • node: NodeId | BaseNode<BaseNodeEvents>

  Returns void

dispose

• dispose(): void

  Returns void

findCorrespondingBasicDataType

• findCorrespondingBasicDataType(dataType: NodeIdLike | UADataType): DataType

  Parameters

  • dataType: NodeIdLike | UADataType

  Returns DataType

findDataType

• findDataType(
      dataType: string | NodeId | DataType | UADataType,
      namespaceIndex?: number,
  ): UADataType | null

  Parameters

  • dataType: string | NodeId | DataType | UADataType
  • OptionalnamespaceIndex: number

  Returns UADataType | null

findEventType

• findEventType(
      eventTypeId: NodeIdLike | UAObjectType,
      namespaceIndex?: number,
  ): UAObjectType | null

  find an EventType node in the address space

  Parameters

  • eventTypeId: NodeIdLike | UAObjectType

    the eventType to find

  • OptionalnamespaceIndex: number

    an optional index to restrict the search in a given namespace

  Returns UAObjectType | null

  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

  Example

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

findMethod

• findMethod(nodeId: NodeIdLike): UAMethod<UAMethodEvents> | null

  Parameters

  • nodeId: NodeIdLike

  Returns UAMethod<UAMethodEvents> | null

findNode

• findNode(node: NodeIdLike): BaseNode<BaseNodeEvents> | null

  Parameters

  • node: NodeIdLike

  Returns BaseNode<BaseNodeEvents> | null

findObjectType

• findObjectType(
      objectTypeId: NodeIdLike,
      namespaceIndex?: number,
  ): UAObjectType | null

  find an EventType node in the address space

  Parameters

  • objectTypeId: NodeIdLike

    the eventType to find

  • OptionalnamespaceIndex: number

    an optional index to restrict the search in a given namespace

  Returns UAObjectType | null

  the EventType found or null.

  notes:

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

  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");
  Copy

findReferenceType

• findReferenceType(
      referenceTypeId: NodeIdLike | UAReferenceType,
      namespaceIndex?: number,
  ): UAReferenceType | null

  Parameters

  • referenceTypeId: NodeIdLike | UAReferenceType
  • OptionalnamespaceIndex: number

  Returns UAReferenceType | null

findReferenceTypeFromInverseName

• findReferenceTypeFromInverseName(inverseName: string): UAReferenceType | null

  find a ReferenceType by its inverse name.

  Parameters

  • inverseName: string

    the inverse name of the ReferenceType to find

  Returns UAReferenceType | null

findVariableType

• findVariableType(
      variableTypeId: NodeIdLike,
      namespaceIndex?: number,
  ): UAVariableType | null

  Parameters

  • variableTypeId: NodeIdLike
  • OptionalnamespaceIndex: number

  Returns UAVariableType | null

  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");
  Copy

generateEventId

• generateEventId(): VariantByteString

  EventId is generated by the Server to uniquely identify a particular Event Notification.

  Returns VariantByteString

getDefaultNamespace

• getDefaultNamespace(): INamespace

  Returns INamespace

getExtensionObjectConstructor

• getExtensionObjectConstructor(dataType: NodeId | UADataType): AnyConstructable

  get the extension object constructor from a DataType nodeID or UADataType object

  Parameters

  • dataType: NodeId | UADataType

  Returns AnyConstructable

getNamespace

• getNamespace(indexOrName: string | number): INamespace

  Parameters

  • indexOrName: string | number

  Returns INamespace

getNamespaceArray

• getNamespaceArray(): INamespace[]

  Returns INamespace[]

getNamespaceIndex

• getNamespaceIndex(namespaceUri: string): number

  Parameters

  • namespaceUri: string

  Returns number

getNamespaceUri

• getNamespaceUri(namespaceIndex: number): string

  Parameters

  • namespaceIndex: number

  Returns string

installAlarmsAndConditionsService

• installAlarmsAndConditionsService(): void

  Returns void

installHistoricalDataNode

• installHistoricalDataNode(
      variableNode: UAVariable,
      options?: IHistoricalDataNodeOptions,
  ): void

  Parameters

  • variableNode: UAVariable
  • Optionaloptions: IHistoricalDataNodeOptions

  Returns void

inverseReferenceType

• inverseReferenceType(referenceType: string): string

  Parameters

  • referenceType: string

  Returns string

normalizeReferenceType

• normalizeReferenceType(params: AddReferenceOpts | UAReference): UAReference

  Parameters

  • params: AddReferenceOpts | UAReference

  Returns UAReference

registerShutdownTask

• registerShutdownTask(task: ShutdownTask): void

  register a task that will be executed just before the address space is disposed.

  Parameters

  • task: ShutdownTask

  Returns void

removeMethodCallInterceptor

• removeMethodCallInterceptor(interceptor: MethodCallInterceptor): void

  Remove a previously registered method call interceptor.

  Parameters

  • interceptor: MethodCallInterceptor

  Returns void

resolveNodeId

• resolveNodeId(nodeIdLike: NodeIdLike): NodeId

  Parameters

  • nodeIdLike: NodeIdLike

  Returns NodeId

shutdown

• shutdown(): Promise<void>

  shutdown the address space by executingthe registered shutdown tasks.

  Returns Promise<void>

  See

  registerShutdownTask, dispose