Interface AddressSpacePrivate

Hierarchy

AddressSpace
- AddressSpacePrivate

Implemented by

AddressSpace

Properties

Methods

Properties

_condition_refresh_in_progress

_condition_refresh_in_progress: boolean

Optional _readProcessedDetails

_readProcessedDetails: function

Type declaration

- (variable: UAVariable, context: SessionContext, historyReadDetails: ReadProcessedDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationPoint: ContinuationPoint | null, callback: CallbackT<HistoryReadResult>): void
- Parameters
  - variable: UAVariable
  - context: SessionContext
  - historyReadDetails: ReadProcessedDetails
  - indexRange: NumericRange | null
  - dataEncoding: QualifiedNameLike | null
  - continuationPoint: ContinuationPoint | null
  - callback: CallbackT<HistoryReadResult>
  Returns void

Optional historizingNodes

historizingNodes: object

Type declaration

[key: string]: UAVariable

isFrugal

isFrugal: boolean

rootFolder

rootFolder: RootFolder

suspendBackReference

suspendBackReference: boolean

Static historizerFactory

historizerFactory: any

Methods

_coerceFolder

_coerceFolder(folder: string | BaseNodePublic | NodeId): BaseNodePublic | null

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:37
Parameters
- folder: string | BaseNodePublic | NodeId
Returns BaseNodePublic | null

_coerceNode

_coerceNode(node: string | BaseNodePublic | NodeId): BaseNodePublic | null

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:35
Parameters
- node: string | BaseNodePublic | NodeId
Returns BaseNodePublic | null

_coerceType

_coerceType(baseType: string | NodeId | BaseNodePublic, topMostBaseType: string, nodeClass: NodeClass): UAVariableType | UAObjectType

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:41
Parameters
- baseType: string | NodeId | BaseNodePublic
- topMostBaseType: string
- nodeClass: NodeClass
Returns UAVariableType | UAObjectType

_coerceTypeDefinition

_coerceTypeDefinition(typeDefinition: string | NodeId): NodeId

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:46
Parameters
- typeDefinition: string | NodeId
Returns NodeId

_coerce_DataType

_coerce_DataType(dataType: NodeIdLike | BaseNodePublic): NodeId

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:39
Parameters
- dataType: NodeIdLike | BaseNodePublic
Returns NodeId

_coerce_VariableTypeIds

_coerce_VariableTypeIds(dataType: NodeId | string | BaseNodePublic): NodeId

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:48
Parameters
- dataType: NodeId | string | BaseNodePublic
Returns NodeId

_collectModelChange

_collectModelChange(view: UAView | null, data: ModelChangeStructureDataType): void

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:74
Parameters
- view: UAView | null
- data: ModelChangeStructureDataType
Returns void

_register

_register(node: BaseNodePublic): void

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:68
Parameters
- node: BaseNodePublic
Returns void

browsePath

browsePath(browsePath: BrowsePath): BrowsePathResult

Inherited from AddressSpacePrivate.browsePath
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2456
Parameters
- browsePath: BrowsePath
Returns BrowsePathResult

browseSingleNode

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

Inherited from AddressSpacePrivate.browseSingleNode
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2454
Parameters
- nodeId: NodeIdLike
- browseDescription: BrowseDescription
- Optional context: SessionContext
Returns BrowseResult

constructEventData

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

Inherited from AddressSpacePrivate.constructEventData
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2486
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: UADataType | NodeId, options?: any): ExtensionObject

Overrides AddressSpace.constructExtensionObject
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:62
Parameters
- dataType: UADataType | NodeId
- Optional options: any
Returns ExtensionObject

deleteNode

deleteNode(nodeId: NodeId): void

Overrides AddressSpace.deleteNode
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:76
Parameters
- nodeId: NodeId
Returns void

dispose

dispose(): void

Inherited from AddressSpacePrivate.dispose
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2502
Returns void

extractRootViews

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

Inherited from AddressSpacePrivate.extractRootViews
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2495
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.

internal

Parameters
- node: UAObject | UAVariable
Returns UAView[]

findCorrespondingBasicDataType

findCorrespondingBasicDataType(dataType: NodeIdLike | UADataType): DataType

Inherited from AddressSpacePrivate.findCorrespondingBasicDataType
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2436
Parameters
- dataType: NodeIdLike | UADataType
Returns DataType

findDataType

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

Inherited from AddressSpacePrivate.findDataType
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2434
Parameters
- dataType: string | NodeId | UADataType | DataType
- Optional namespaceIndex: number
Returns UADataType | null

findEventType

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

Inherited from AddressSpacePrivate.findEventType
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2424
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

Inherited from AddressSpacePrivate.findMethod
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2370
Parameters
- nodeId: NodeIdLike
Returns UAMethod | null

findNode

findNode(node: NodeIdLike): BaseNode | null

Inherited from AddressSpacePrivate.findNode
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2351
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

Inherited from AddressSpacePrivate.findReferenceType
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2426
Parameters
- referenceTypeId: NodeIdLike | UAReferenceType
- Optional namespaceIndex: number
Returns UAReferenceType | null

findReferenceTypeFromInverseName

findReferenceTypeFromInverseName(inverseName: string): UAReferenceType | null

Inherited from AddressSpacePrivate.findReferenceTypeFromInverseName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2432
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(): VariantByteString

Inherited from AddressSpacePrivate.generateEventId
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2511
EventId is generated by the Server to uniquely identify a particular Event Notification.

Returns VariantByteString

getDataTypeManager

getDataTypeManager(): ExtraDataTypeManager

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:78
Returns ExtraDataTypeManager

getDefaultNamespace

getDefaultNamespace(): NamespacePrivate

Overrides AddressSpace.getDefaultNamespace
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:50
Returns NamespacePrivate

getExtensionObjectConstructor

getExtensionObjectConstructor(dataType: NodeId | UADataType): ExtensionObjectConstructorFuncWithSchema

Overrides AddressSpace.getExtensionObjectConstructor
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:60
Parameters
- dataType: NodeId | UADataType
Returns ExtensionObjectConstructorFuncWithSchema

getNamespace

getNamespace(indexOrName: number | string): NamespacePrivate

Overrides AddressSpace.getNamespace
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:54
Parameters
- indexOrName: number | string
Returns NamespacePrivate

getNamespaceArray

getNamespaceArray(): NamespacePrivate[]

Overrides AddressSpace.getNamespaceArray
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:58
Returns NamespacePrivate[]

getNamespaceIndex

getNamespaceIndex(namespaceUri: string): number

Inherited from AddressSpacePrivate.getNamespaceIndex
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2448
Parameters
- namespaceUri: string
Returns number

getNamespaceUri

getNamespaceUri(namespaceIndex: number): string

Inherited from AddressSpacePrivate.getNamespaceUri
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2450
Parameters
- namespaceIndex: number
Returns string

getOwnNamespace

getOwnNamespace(): NamespacePrivate

Overrides AddressSpace.getOwnNamespace
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:52
Returns NamespacePrivate

installAlarmsAndConditionsService

installAlarmsAndConditionsService(): void

Inherited from AddressSpacePrivate.installAlarmsAndConditionsService
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2504
Returns void

installHistoricalDataNode

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

Inherited from AddressSpacePrivate.installHistoricalDataNode
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2498
Parameters
- variableNode: UAVariable
- Optional options: IHistoricalDataNodeOptions
Returns void

inverseReferenceType

inverseReferenceType(referenceType: string): string

Inherited from AddressSpacePrivate.inverseReferenceType
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2458
Parameters
- referenceType: string
Returns string

isEnumeration

isEnumeration(dataType: NodeId): boolean

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:91
Parameters
- dataType: NodeId
Returns boolean

modelChangeTransaction

modelChangeTransaction(action: function): void

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:72
Parameters
- action: function
  - - (): void
    - Returns void
Returns void

normalizeReferenceType

normalizeReferenceType(params: AddReferenceOpts | Reference): Reference

Overrides AddressSpace.normalizeReferenceType
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:64
Parameters
- params: AddReferenceOpts | Reference
Returns Reference

normalizeReferenceTypes

normalizeReferenceTypes(references: AddReferenceOpts[] | Reference[] | null): Reference[]

- Defined in packages/node-opcua-address-space/src/address_space_private.ts:66
Parameters
- references: AddReferenceOpts[] | Reference[] | null
Returns Reference[]

registerNamespace

registerNamespace(namespaceUri: string): NamespacePrivate

Overrides AddressSpace.registerNamespace
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:56
Parameters
- namespaceUri: string
Returns NamespacePrivate

resolveNodeId

resolveNodeId(nodeIdLike: NodeIdLike): NodeId

Overrides AddressSpace.resolveNodeId
- Defined in packages/node-opcua-address-space/src/address_space_private.ts:70
Parameters
- nodeIdLike: NodeIdLike
Returns NodeId

shutdown

shutdown(): void

Inherited from AddressSpacePrivate.shutdown
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2500
Returns void

Static create

create(): AddressSpace

Inherited from AddressSpacePrivate.create
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2524
Returns AddressSpace

Interface AddressSpacePrivate

Hierarchy

Implemented by

Properties

Methods

Properties

_condition_refresh_in_progress

Optional _readProcessedDetails

Type declaration

Parameters

variable: UAVariable

context: SessionContext

historyReadDetails: ReadProcessedDetails

indexRange: NumericRange | null

dataEncoding: QualifiedNameLike | null

continuationPoint: ContinuationPoint | null

callback: CallbackT<HistoryReadResult>

Returns void

Optional historizingNodes

Type declaration

[key: string]: UAVariable

isFrugal

rootFolder

suspendBackReference

Static historizerFactory

Methods

_coerceFolder

Parameters

folder: string | BaseNodePublic | NodeId

Returns BaseNodePublic | null

_coerceNode

Parameters

node: string | BaseNodePublic | NodeId

Returns BaseNodePublic | null

_coerceType

Parameters

baseType: string | NodeId | BaseNodePublic

topMostBaseType: string

nodeClass: NodeClass

Returns UAVariableType | UAObjectType

_coerceTypeDefinition

Parameters

typeDefinition: string | NodeId

Returns NodeId

_coerce_DataType

Parameters

dataType: NodeIdLike | BaseNodePublic

Returns NodeId

_coerce_VariableTypeIds

Parameters

dataType: NodeId | string | BaseNodePublic

Returns NodeId

_collectModelChange

Parameters

view: UAView | null

data: ModelChangeStructureDataType

Returns void

_register

Parameters

node: BaseNodePublic

Returns void

browsePath

Parameters

browsePath: BrowsePath

Returns BrowsePathResult

browseSingleNode

Parameters

nodeId: NodeIdLike

browseDescription: BrowseDescription

Optional context: SessionContext

Returns BrowseResult

constructEventData

Parameters

eventTypeId: UAEventType

data: any

Returns IEventData

constructExtensionObject

Parameters

dataType: UADataType | NodeId

Optional options: any