AddressSpace | NodeOPCUA reference documentation

Hierarchy

IAddressSpace
- AddressSpace

Index

Properties

Methods

Properties

Optional historizingNodes

historizingNodes: {}

Type declaration

[key: string]: UAVariable

isFrugal

isFrugal: boolean

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

rootFolder

rootFolder: UARootFolder

Static historizerFactory

historizerFactory: any

Methods

browsePath

browsePath(browsePath: BrowsePath): BrowsePathResult

Inherited from IAddressSpace.browsePath
- Defined in node-opcua-address-space-base/source/address_space.ts:142
Parameters
- browsePath: BrowsePath
Returns BrowsePathResult

browseSingleNode

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

Inherited from IAddressSpace.browseSingleNode
- Defined in node-opcua-address-space-base/source/address_space.ts:140
Parameters
- nodeId: NodeIdLike
- browseDescription: BrowseDescription
- Optional context: ISessionContext
Returns BrowseResult

constructEventData

constructEventData(eventTypeId: UAEventType, data: any): IEventData

Inherited from IAddressSpace.constructEventData
- Defined in node-opcua-address-space-base/source/address_space.ts:172
construct a simple javascript object with all the default properties of the event

Parameters
- eventTypeId: UAEventType
- data: any
Returns IEventData

result.$eventDataSource the event type node

constructExtensionObject

constructExtensionObject(dataType: NodeId | UADataType, options?: any): ExtensionObject

Inherited from IAddressSpace.constructExtensionObject
- Defined in node-opcua-address-space-base/source/address_space.ts:156
construct an extension object constructor from a DataType nodeID or UADataType object

Parameters
- dataType: NodeId | UADataType
- Optional options: any
Returns ExtensionObject

deleteNode

deleteNode(node: NodeId | BaseNode): void

Inherited from IAddressSpace.deleteNode
- Defined in node-opcua-address-space-base/source/address_space.ts:124
Parameters
- node: NodeId | BaseNode
Returns void

dispose

dispose(): void

Inherited from IAddressSpace.dispose
- Defined in node-opcua-address-space-base/source/address_space.ts:191
Returns void

findCorrespondingBasicDataType

findCorrespondingBasicDataType(dataType: NodeIdLike | UADataType): DataType

Inherited from IAddressSpace.findCorrespondingBasicDataType
- Defined in node-opcua-address-space-base/source/address_space.ts:122
Parameters
- dataType: NodeIdLike | UADataType
Returns DataType

findDataType

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

Inherited from IAddressSpace.findDataType
- Defined in node-opcua-address-space-base/source/address_space.ts:120
Parameters
- dataType: string | NodeId | DataType | UADataType
- Optional namespaceIndex: number
Returns UADataType

findEventType

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

Inherited from IAddressSpace.findEventType
- Defined in node-opcua-address-space-base/source/address_space.ts:110
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

findMethod(nodeId: NodeIdLike): UAMethod

Inherited from IAddressSpace.findMethod
- Defined in node-opcua-address-space-base/source/address_space.ts:56
Parameters
- nodeId: NodeIdLike
Returns UAMethod

findNode

findNode(node: NodeIdLike): BaseNode

Inherited from IAddressSpace.findNode
- Defined in node-opcua-address-space-base/source/address_space.ts:37
Parameters
- node: NodeIdLike
Returns BaseNode

findObjectType

findObjectType(objectTypeId: NodeIdLike, namespaceIndex?: number): UAObjectType

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

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

Inherited from IAddressSpace.findReferenceType
- Defined in node-opcua-address-space-base/source/address_space.ts:112
Parameters
- referenceTypeId: NodeIdLike | UAReferenceType
- Optional namespaceIndex: number
Returns UAReferenceType

findReferenceTypeFromInverseName

findReferenceTypeFromInverseName(inverseName: string): UAReferenceType

Inherited from IAddressSpace.findReferenceTypeFromInverseName
- Defined in node-opcua-address-space-base/source/address_space.ts:118
find a ReferenceType by its inverse name.

Parameters
- inverseName: string
  
  the inverse name of the ReferenceType to find
Returns UAReferenceType

findVariableType

findVariableType(variableTypeId: NodeIdLike, namespaceIndex?: number): UAVariableType

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

generateEventId(): VariantByteString

Inherited from IAddressSpace.generateEventId
- Defined in node-opcua-address-space-base/source/address_space.ts:200
EventId is generated by the Server to uniquely identify a particular Event Notification.

Returns VariantByteString

getDefaultNamespace

getDefaultNamespace(): INamespace

Inherited from IAddressSpace.getDefaultNamespace
- Defined in node-opcua-address-space-base/source/address_space.ts:126
Returns INamespace

getExtensionObjectConstructor

getExtensionObjectConstructor(dataType: NodeId | UADataType): AnyConstructable

Inherited from IAddressSpace.getExtensionObjectConstructor
- Defined in node-opcua-address-space-base/source/address_space.ts:150
get the extension object constructor from a DataType nodeID or UADataType object

Parameters
- dataType: NodeId | UADataType
Returns AnyConstructable

getNamespace

getNamespace(indexOrName: string | number): INamespace

Inherited from IAddressSpace.getNamespace
- Defined in node-opcua-address-space-base/source/address_space.ts:130
Parameters
- indexOrName: string | number
Returns INamespace

getNamespaceArray

getNamespaceArray(): INamespace[]

Inherited from IAddressSpace.getNamespaceArray
- Defined in node-opcua-address-space-base/source/address_space.ts:138
Returns INamespace[]

getNamespaceIndex

getNamespaceIndex(namespaceUri: string): number

Inherited from IAddressSpace.getNamespaceIndex
- Defined in node-opcua-address-space-base/source/address_space.ts:134
Parameters
- namespaceUri: string
Returns number

getNamespaceUri

getNamespaceUri(namespaceIndex: number): string

Inherited from IAddressSpace.getNamespaceUri
- Defined in node-opcua-address-space-base/source/address_space.ts:136
Parameters
- namespaceIndex: number
Returns string

getOwnNamespace

getOwnNamespace(): Namespace

Overrides IAddressSpace.getOwnNamespace
- Defined in node-opcua-address-space/source/address_space_ts.ts:140
Returns Namespace

installAlarmsAndConditionsService

installAlarmsAndConditionsService(): void

Inherited from IAddressSpace.installAlarmsAndConditionsService
- Defined in node-opcua-address-space-base/source/address_space.ts:193
Returns void

installHistoricalDataNode

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

Inherited from IAddressSpace.installHistoricalDataNode
- Defined in node-opcua-address-space-base/source/address_space.ts:184
Parameters
- variableNode: UAVariable
- Optional options: IHistoricalDataNodeOptions
Returns void

inverseReferenceType

inverseReferenceType(referenceType: string): string

Inherited from IAddressSpace.inverseReferenceType
- Defined in node-opcua-address-space-base/source/address_space.ts:144
Parameters
- referenceType: string
Returns string

normalizeReferenceType

normalizeReferenceType(params: UAReference | AddReferenceOpts): UAReference

Inherited from IAddressSpace.normalizeReferenceType
- Defined in node-opcua-address-space-base/source/address_space.ts:195
Parameters
- params: UAReference | AddReferenceOpts
Returns UAReference

registerNamespace

registerNamespace(namespaceUri: string): Namespace

Overrides IAddressSpace.registerNamespace
- Defined in node-opcua-address-space/source/address_space_ts.ts:141
Parameters
- namespaceUri: string
Returns Namespace

registerShutdownTask

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

Inherited from IAddressSpace.registerShutdownTask
- Defined in node-opcua-address-space-base/source/address_space.ts:187
Parameters
- task: () => void
  - - (): void
    - Returns void
Returns void

resolveNodeId

resolveNodeId(nodeIdLike: NodeIdLike): NodeId

Inherited from IAddressSpace.resolveNodeId
- Defined in node-opcua-address-space-base/source/address_space.ts:35
Parameters
- nodeIdLike: NodeIdLike
Returns NodeId

shutdown

shutdown(): void

Inherited from IAddressSpace.shutdown
- Defined in node-opcua-address-space-base/source/address_space.ts:189
Returns void

Static create

create(): AddressSpace

- Defined in node-opcua-address-space/source/address_space_ts.ts:147
Returns AddressSpace

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

Optional historizingNodes

Type declaration

[key: string]: UAVariable

isFrugal

rootFolder

Static historizerFactory

Methods

browsePath

Parameters

browsePath: BrowsePath

Returns BrowsePathResult

browseSingleNode

Parameters

nodeId: NodeIdLike

browseDescription: BrowseDescription

Optional context: ISessionContext

Returns BrowseResult

constructEventData

Parameters

eventTypeId: UAEventType

data: any

Returns IEventData

constructExtensionObject

Parameters

dataType: NodeId | UADataType

Optional options: any

Returns ExtensionObject

deleteNode

Parameters

node: NodeId | BaseNode

Returns void

dispose

Returns void

findCorrespondingBasicDataType

Parameters

dataType: NodeIdLike | UADataType

Returns DataType

findDataType

Parameters

dataType: string | NodeId | DataType | UADataType

Optional namespaceIndex: number

Returns UADataType

findEventType

Parameters

eventTypeId: NodeIdLike | UAObjectType

Optional namespaceIndex: number

Returns UAObjectType

findMethod

Parameters

nodeId: NodeIdLike

Returns UAMethod

findNode

Parameters

node: NodeIdLike

Returns BaseNode

findObjectType

Parameters

objectTypeId: NodeIdLike

Optional namespaceIndex: number

Returns UAObjectType

findReferenceType

Parameters

referenceTypeId: NodeIdLike | UAReferenceType

Optional namespaceIndex: number

Returns UAReferenceType

findReferenceTypeFromInverseName

Parameters

inverseName: string

Returns UAReferenceType

findVariableType

Parameters

variableTypeId: NodeIdLike

Optional namespaceIndex: number

Returns UAVariableType