AddressSpace | node-opcua-client

Hierarchy

AddressSpace

Index

Properties

Optional historizingNodes

historizingNodes: any

isFrugal

isFrugal: boolean

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

rootFolder

rootFolder: RootFolder

Static historizerFactory

historizerFactory: any

Methods

browsePath

browsePath(browsePath: BrowsePath): BrowsePathResult

- Defined in node-opcua-address-space/source/address_space_ts.ts:2377
Parameters
- browsePath: BrowsePath
Returns BrowsePathResult

browseSingleNode

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

- Defined in node-opcua-address-space/source/address_space_ts.ts:2371
Parameters
- nodeId: NodeIdLike
- browseDescription: BrowseDescription
- Optional context: SessionContext
Returns BrowseResult

constructEventData

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

- Defined in node-opcua-address-space/source/address_space_ts.ts:2398
construct a simple javascript object with all the default properties of the event

Parameters
- eventTypeId: UAEventType
- data: any
Returns EventData

result.$eventDataSource the event type node

constructExtensionObject

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

- Defined in node-opcua-address-space/source/address_space_ts.ts:2382
Parameters
- dataType: UADataType | NodeId
- Optional options: any
Returns ExtensionObject

deleteNode

deleteNode(node: NodeId | BaseNode): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:2355
Parameters
- node: NodeId | BaseNode
Returns void

dispose

dispose(): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:2417
Returns void

extractRootViews

extractRootViews(node: UAObject | UAVariable): UAView[]

- Defined in node-opcua-address-space/source/address_space_ts.ts:2407
walk up the hierarchy of objects until a view is found objects may belong to multiples views. Note: this method doesn't return the main view => Server object.

Parameters
- node: UAObject | UAVariable
Returns UAView[]

findCorrespondingBasicDataType

findCorrespondingBasicDataType(dataType: NodeIdLike | UADataType): DataType

- Defined in node-opcua-address-space/source/address_space_ts.ts:2353
Parameters
- dataType: NodeIdLike | UADataType
Returns DataType

findDataType

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

- Defined in node-opcua-address-space/source/address_space_ts.ts:2348
Parameters
- dataType: string | NodeId | UADataType | DataType
- Optional namespaceIndex: number
Returns UADataType | null

findEventType

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

- Defined in node-opcua-address-space/source/address_space_ts.ts:2332
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 | 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

findMethod

findMethod(nodeId: NodeIdLike): UAMethod | null

- Defined in node-opcua-address-space/source/address_space_ts.ts:2278
Parameters
- nodeId: NodeIdLike
Returns UAMethod | null

findNode

findNode(node: NodeIdLike): BaseNode | null

- Defined in node-opcua-address-space/source/address_space_ts.ts:2259
Parameters
- node: NodeIdLike
Returns BaseNode | null

findObjectType

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

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 | null

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 | null

- Defined in node-opcua-address-space/source/address_space_ts.ts:2337
Parameters
- referenceTypeId: NodeIdLike | UAReferenceType
- Optional namespaceIndex: number
Returns UAReferenceType | null

findReferenceTypeFromInverseName

findReferenceTypeFromInverseName(inverseName: string): UAReferenceType | null

- Defined in node-opcua-address-space/source/address_space_ts.ts:2346
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

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 | null

generateEventId

generateEventId(): VariantT<ByteString>

- Defined in node-opcua-address-space/source/address_space_ts.ts:2428
EventId is generated by the Server to uniquely identify a particular Event Notification.

Returns VariantT<ByteString>

getDefaultNamespace

getDefaultNamespace(): Namespace

- Defined in node-opcua-address-space/source/address_space_ts.ts:2357
Returns Namespace

getNamespace

getNamespace(indexOrName: number | string): Namespace

- Defined in node-opcua-address-space/source/address_space_ts.ts:2361
Parameters
- indexOrName: number | string
Returns Namespace

getNamespaceArray

getNamespaceArray(): Namespace[]

- Defined in node-opcua-address-space/source/address_space_ts.ts:2369
Returns Namespace[]

getNamespaceIndex

getNamespaceIndex(namespaceUri: string): number

- Defined in node-opcua-address-space/source/address_space_ts.ts:2365
Parameters
- namespaceUri: string
Returns number

getNamespaceUri

getNamespaceUri(namespaceIndex: number): string

- Defined in node-opcua-address-space/source/address_space_ts.ts:2367
Parameters
- namespaceIndex: number
Returns string

getOwnNamespace

getOwnNamespace(): Namespace

- Defined in node-opcua-address-space/source/address_space_ts.ts:2359
Returns Namespace

installAlarmsAndConditionsService

installAlarmsAndConditionsService(): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:2419
Returns void

installHistoricalDataNode

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

- Defined in node-opcua-address-space/source/address_space_ts.ts:2410
Parameters
- variableNode: UAVariable
- Optional options: IHistoricalDataNodeOptions
Returns void

inverseReferenceType

inverseReferenceType(referenceType: string): string

- Defined in node-opcua-address-space/source/address_space_ts.ts:2379
Parameters
- referenceType: string
Returns string

normalizeReferenceType

normalizeReferenceType(params: AddReferenceOpts | Reference): Reference

- Defined in node-opcua-address-space/source/address_space_ts.ts:2421
Parameters
- params: AddReferenceOpts | Reference
Returns Reference

registerNamespace

registerNamespace(namespaceUri: string): Namespace

- Defined in node-opcua-address-space/source/address_space_ts.ts:2363
Parameters
- namespaceUri: string
Returns Namespace

shutdown

shutdown(): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:2415
Returns void

Static create

create(): AddressSpace

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

Hierarchy

Index

Properties

Methods

Properties

Optional historizingNodes

isFrugal

rootFolder

Static historizerFactory

Methods

browsePath

Parameters

browsePath: BrowsePath

Returns BrowsePathResult

browseSingleNode

Parameters

nodeId: NodeIdLike

browseDescription: BrowseDescription

Optional context: SessionContext

Returns BrowseResult

constructEventData

Parameters

eventTypeId: UAEventType

data: any

Returns EventData

constructExtensionObject

Parameters

dataType: UADataType | NodeId

Optional options: any

Returns ExtensionObject

deleteNode

Parameters

node: NodeId | BaseNode

Returns void

dispose

Returns void

extractRootViews

Parameters

node: UAObject | UAVariable

Returns UAView[]

findCorrespondingBasicDataType

Parameters

dataType: NodeIdLike | UADataType

Returns DataType

findDataType

Parameters

dataType: string | NodeId | UADataType | DataType

Optional namespaceIndex: number

Returns UADataType | null

findEventType

Parameters

eventTypeId: NodeIdLike | UAObjectType

Optional namespaceIndex: number

Returns UAObjectType | null

findMethod

Parameters

nodeId: NodeIdLike

Returns UAMethod | null

findNode

Parameters

node: NodeIdLike

Returns BaseNode | null

findObjectType

Parameters

objectTypeId: NodeIdLike

Optional namespaceIndex: number

Returns UAObjectType | null

findReferenceType

Parameters

referenceTypeId: NodeIdLike | UAReferenceType

Optional namespaceIndex: number

Returns UAReferenceType | null

findReferenceTypeFromInverseName

Parameters

inverseName: string

Returns UAReferenceType | null

findVariableType

Parameters

variableTypeId: NodeIdLike

Optional namespaceIndex: number