Class UANamespace

params: options {Object}
params: options.namespaceUri {string}
params: options.addressSpace {AddressSpace}
params: options.index {number}
params: options.version="" {string}
params: options.publicationDate="" {Date}

Hierarchy

UANamespace

Implements

Namespace

Constructors

constructor

Properties

Methods

Constructors

constructor

new UANamespace(options: any): UANamespace

- Defined in packages/node-opcua-address-space/src/namespace.ts:209
Parameters
- options: any
Returns UANamespace

Properties

addressSpace

addressSpace: AddressSpacePrivate

Readonly index

index: number

Readonly namespaceUri

namespaceUri: string

publicationDate

publicationDate: Date = new Date(1900, 0, 1)

version

version: number = 0

Static _handle_hierarchy_parent

_handle_hierarchy_parent: _handle_hierarchy_parent = _handle_hierarchy_parent

Static isNonEmptyQualifiedName

isNonEmptyQualifiedName: isNonEmptyQualifiedName = isNonEmptyQualifiedName

Methods

_aliasCount

_aliasCount(): number

- Defined in packages/node-opcua-address-space/src/namespace.ts:281
Returns number

_createNode

_createNode(options: CreateNodeOptions): BaseNode

Implementation of Namespace._createNode
- Defined in packages/node-opcua-address-space/src/namespace.ts:1665
method

_createNode

internal

Parameters
- options: CreateNodeOptions
Returns BaseNode

_dataTypeCount

_dataTypeCount(): number

- Defined in packages/node-opcua-address-space/src/namespace.ts:272
Returns number

_dataTypeIterator

_dataTypeIterator(): IterableIterator<UADataType>

- Defined in packages/node-opcua-address-space/src/namespace.ts:269
Returns IterableIterator<UADataType>

_deleteNode

_deleteNode(node: BaseNode): void

- Defined in packages/node-opcua-address-space/src/namespace.ts:1744
Parameters
- node: BaseNode
Returns void

_objectTypeCount

_objectTypeCount(): number

- Defined in packages/node-opcua-address-space/src/namespace.ts:260
Returns number

_objectTypeIterator

_objectTypeIterator(): IterableIterator<UAObjectType>

- Defined in packages/node-opcua-address-space/src/namespace.ts:257
Returns IterableIterator<UAObjectType>

_referenceTypeCount

_referenceTypeCount(): number

- Defined in packages/node-opcua-address-space/src/namespace.ts:278
Returns number

_referenceTypeIterator

_referenceTypeIterator(): IterableIterator<UAReferenceType>

- Defined in packages/node-opcua-address-space/src/namespace.ts:275
Returns IterableIterator<UAReferenceType>

_register

_register(node: BaseNode): void

- Defined in packages/node-opcua-address-space/src/namespace.ts:1590
Parameters
- node: BaseNode
Returns void

_variableTypeCount

_variableTypeCount(): number

- Defined in packages/node-opcua-address-space/src/namespace.ts:266
Returns number

_variableTypeIterator

_variableTypeIterator(): IterableIterator<UAVariableType>

- Defined in packages/node-opcua-address-space/src/namespace.ts:263
Returns IterableIterator<UAVariableType>

addAlias

addAlias(alias_name: string, nodeId: NodeId): void

Implementation of Namespace.addAlias
- Defined in packages/node-opcua-address-space/src/namespace.ts:354
method

addAlias

Parameters
- alias_name: string
  
  the alias name
- nodeId: NodeId
  
  NodeId must belong to this namespace
Returns void

addAnalogDataItem

addAnalogDataItem(options: AddAnalogDataItemOptions): UAAnalogItem

Implementation of Namespace.addAnalogDataItem
- Defined in packages/node-opcua-address-space/src/namespace.ts:844
method

addAnalogDataItem

AnalogDataItem DataItems that represent continuously-variable physical quantities ( e.g., length, temperature), in contrast to the digital representation of data in discrete items NOTE Typical examples are the values provided by temperature sensors or pressure sensors. OPC UA defines a specific UAVariableType to identify an AnalogItem. Properties describe the possible ranges of AnalogItems.

example:
namespace.add_analog_dataItem({ componentOf: parentObject, browseName: "TemperatureSensor",
```
 definition: "(tempA -25) + tempB",
 valuePrecision: 0.5,
 //-
 instrumentRange: { low: 100 , high: 200}, // optional
 engineeringUnitsRange: { low: 100 , high: 200}, // mandatory
 engineeringUnits: standardUnits.degree_celsius,, // optional

 // access level
 accessLevel: 1
 minimumSamplingInterval: 10,
```
});
Parameters
- options: AddAnalogDataItemOptions
Returns UAAnalogItem

addDataItem

addDataItem(options: AddDataItemOptions): UADataItem

Implementation of Namespace.addDataItem
- Defined in packages/node-opcua-address-space/src/namespace.ts:776
method

addDataItem

Parameters
- options: AddDataItemOptions
Returns UADataItem

addEnumerationType

addEnumerationType(options: AddEnumerationTypeOptions): UADataType

Implementation of Namespace.addEnumerationType
- Defined in packages/node-opcua-address-space/src/namespace.ts:1215
method

addEnumerationType

Parameters
- options: AddEnumerationTypeOptions
Returns UADataType

addEventType

addEventType(options: any): UAObjectType

add a new event type to the address space

method

addEventType

example

 var evtType = namespace.addEventType({
     browseName: "MyAuditEventType",
     subtypeOf:  "AuditEventType"
 });
 var myConditionType = namespace.addEventType({
     browseName: "MyConditionType",
     subtypeOf:  "ConditionType",
     isAbstract: false
 });

Parameters

options: any

Returns UAObjectType

: the object type

addFolder

addFolder(parentFolder: UAObject, options: AddFolderOptions | string): UAObject

- Defined in packages/node-opcua-address-space/src/namespace.ts:504
method

addFolder

Parameters
- parentFolder: UAObject
- options: AddFolderOptions | string
Returns UAObject

addMethod

addMethod(parentObject: UAObject, options: AddMethodOptions): UAMethod

- Defined in packages/node-opcua-address-space/src/namespace.ts:1118
method

addMethod

Parameters
- parentObject: UAObject
- options: AddMethodOptions
Returns UAMethod

addMultiStateDiscrete

addMultiStateDiscrete(options: AddMultiStateDiscreteOptions): UAMultiStateDiscretePublic

Implementation of Namespace.addMultiStateDiscrete
- Defined in packages/node-opcua-address-space/src/namespace.ts:559
Parameters
- options: AddMultiStateDiscreteOptions
Returns UAMultiStateDiscretePublic

addMultiStateValueDiscrete

addMultiStateValueDiscrete(options: AddMultiStateValueDiscreteOptions): UAMultiStateValueDiscretePublic

method

addMultiStateValueDiscrete

example

 namespace.addMultiStateValueDiscrete({
     componentOf:parentObj,
     browseName: "myVar",
     enumValues: {
         "Red":    0xFF0000,
         "Green":  0x00FF00,
         "Blue":   0x0000FF
     }
 });
 addMultiStateValueDiscrete(parentObj,{
     browseName: "myVar",
     enumValues: [
         {
            value: 0xFF0000,
            displayName: "Red",
            description: " The color Red"
         },
         {
            value: 0x00FF000,
            displayName: "Green",
            description: " The color Green"
         },
         {
            value: 0x0000FF,
            displayName: "Blue",
            description: " The color Blue"
         }

     ]
 });

Parameters

options: AddMultiStateValueDiscreteOptions

Returns UAMultiStateValueDiscretePublic

addObject

addObject(options1: AddObjectOptions): UAObject

Implementation of Namespace.addObject
- Defined in packages/node-opcua-address-space/src/namespace.ts:478
Parameters
- options1: AddObjectOptions
Returns UAObject

addObjectType

addObjectType(options: AddObjectTypeOptions): UAObjectType

Implementation of Namespace.addObjectType
- Defined in packages/node-opcua-address-space/src/namespace.ts:379
add a new Object type to the address space

method

addObjectType

Parameters
- options: AddObjectTypeOptions
Returns UAObjectType

addReferenceType

addReferenceType(options: AddReferenceTypeOptions): UAReferenceType

Implementation of Namespace.addReferenceType
- Defined in packages/node-opcua-address-space/src/namespace.ts:530
method

addReferenceType

Parameters
- options: AddReferenceTypeOptions
Returns UAReferenceType

addState

addState(component: StateMachine, stateName: string, stateNumber: number, isInitialState: boolean): State | InitialState

- Defined in packages/node-opcua-address-space/src/namespace.ts:1414
method

addState

Parameters
- component: StateMachine
- stateName: string
- stateNumber: number
- isInitialState: boolean
Returns State | InitialState

{StateType|InitialStateType}

addTransition

addTransition(component: StateMachine, fromState: string, toState: string, transitionNumber: number): Transition

- Defined in packages/node-opcua-address-space/src/namespace.ts:1454
Parameters
- component: StateMachine
- fromState: string
- toState: string
- transitionNumber: number
Returns Transition

addTwoStateDiscrete

addTwoStateDiscrete(options: AddTwoStateDiscreteOptions): UATwoStateDiscretePublic

Implementation of Namespace.addTwoStateDiscrete
- Defined in packages/node-opcua-address-space/src/namespace.ts:1523
method

addTwoStateDiscrete

Add a TwoStateDiscrete Variable

Parameters
- options: AddTwoStateDiscreteOptions
Returns UATwoStateDiscretePublic

addTwoStateVariable

addTwoStateVariable(options: AddTwoStateVariableOptions): UATwoStateVariablePublic

Implementation of Namespace.addTwoStateVariable
- Defined in packages/node-opcua-address-space/src/namespace.ts:1512
method

addTwoStateVariable

Parameters
- options: AddTwoStateVariableOptions
Returns UATwoStateVariablePublic

addVariable

addVariable(options: AddVariableOptions): UAVariablePublic

Implementation of Namespace.addVariable
- Defined in packages/node-opcua-address-space/src/namespace.ts:434
add a variable as a component of the parent node

method

addVariable

Parameters
- options: AddVariableOptions
Returns UAVariablePublic

UAVariable

addVariableType

addVariableType(options: AddVariableTypeOptions): UAVariableTypePublic

Implementation of Namespace.addVariableType
- Defined in packages/node-opcua-address-space/src/namespace.ts:401
add a new Variable type to the address space

method

addVariableType

Parameters
- options: AddVariableTypeOptions
Returns UAVariableTypePublic

addView

addView(options: AddViewOptions): UAView

Implementation of Namespace.addView
- Defined in packages/node-opcua-address-space/src/namespace.ts:445
Parameters
- options: AddViewOptions
Returns UAView

addYArrayItem

addYArrayItem(options: AddYArrayItemOptions): YArrayItemVariable

Implementation of Namespace.addYArrayItem
- Defined in packages/node-opcua-address-space/src/namespace.ts:1032
method

addYArrayItem

Parameters
- options: AddYArrayItemOptions
Returns YArrayItemVariable

constructNodeId

constructNodeId(options: ConstructNodeIdOptions): NodeId

Implementation of Namespace.constructNodeId
- Defined in packages/node-opcua-address-space/src/namespace.ts:1586
Parameters
- options: ConstructNodeIdOptions
Returns NodeId

createDataType

createDataType(options: CreateDataTypeOptions): UADataType

Implementation of Namespace.createDataType
- Defined in packages/node-opcua-address-space/src/namespace.ts:566
method

createDataType

Parameters
- options: CreateDataTypeOptions
Returns UADataType

createNode

createNode(options: CreateNodeOptions): BaseNode

Implementation of Namespace.createNode
- Defined in packages/node-opcua-address-space/src/namespace.ts:605
method

createNode

internal

Parameters
- options: CreateNodeOptions
Returns BaseNode

deleteNode

deleteNode(nodeOrNodeId: NodeId | BaseNode): void

Implementation of Namespace.deleteNode
- Defined in packages/node-opcua-address-space/src/namespace.ts:648
remove the specified Node from the address space

method

deleteNode

Parameters
- nodeOrNodeId: NodeId | BaseNode
Returns void

dispose

dispose(): void

- Defined in packages/node-opcua-address-space/src/namespace.ts:236
Returns void

findDataType

findDataType(dataTypeName: string): UADataType | null

Implementation of Namespace.findDataType
- Defined in packages/node-opcua-address-space/src/namespace.ts:322
Parameters
- dataTypeName: string
Returns UADataType | null

findNode

findNode(nodeId: string | NodeId): BaseNode | null

- Defined in packages/node-opcua-address-space/src/namespace.ts:290
Parameters
- nodeId: string | NodeId
Returns BaseNode | null

findNode2

findNode2(nodeId: NodeId): BaseNode | null

Implementation of Namespace.findNode2
- Defined in packages/node-opcua-address-space/src/namespace.ts:285
Parameters
- nodeId: NodeId
Returns BaseNode | null

findObjectType

findObjectType(objectTypeName: string): UAObjectType | null

Implementation of Namespace.findObjectType
- Defined in packages/node-opcua-address-space/src/namespace.ts:305
Parameters
- objectTypeName: string
Returns UAObjectType | null

findReferenceType

findReferenceType(referenceTypeName: string): UAReferenceType | null

Implementation of Namespace.findReferenceType
- Defined in packages/node-opcua-address-space/src/namespace.ts:331
Parameters
- referenceTypeName: string
Returns UAReferenceType | null

findReferenceTypeFromInverseName

findReferenceTypeFromInverseName(inverseName: string): UAReferenceType | null

Implementation of Namespace.findReferenceTypeFromInverseName
- Defined in packages/node-opcua-address-space/src/namespace.ts:341
find a ReferenceType by its inverse name.

method

findReferenceTypeFromInverseName

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

findVariableType

findVariableType(variableTypeName: string): UAVariableTypePublic | null

Implementation of Namespace.findVariableType
- Defined in packages/node-opcua-address-space/src/namespace.ts:314
Parameters
- variableTypeName: string
Returns UAVariableTypePublic | null

getDefaultNamespace

getDefaultNamespace(): UANamespace

- Defined in packages/node-opcua-address-space/src/namespace.ts:232
Returns UANamespace

getStandardsNodeIds

getStandardsNodeIds(): object

Implementation of Namespace.getStandardsNodeIds
- Defined in packages/node-opcua-address-space/src/namespace.ts:718
internals

Returns object
- objectTypeIds: object
  - [key: string]: string
- referenceTypeIds: object
  - [key: string]: string

instantiateAcknowledgeableCondition

instantiateAcknowledgeableCondition(conditionTypeId: UAEventType | NodeId | string, options: any, data: any): UAAcknowledgeableConditionBase

Implementation of Namespace.instantiateAcknowledgeableCondition
- Defined in packages/node-opcua-address-space/src/namespace.ts:1533
Parameters
- conditionTypeId: UAEventType | NodeId | string
- options: any
- data: any
Returns UAAcknowledgeableConditionBase

instantiateAlarmCondition

instantiateAlarmCondition(alarmConditionTypeId: UAEventType | NodeId | string, options: any, data: any): UAAlarmConditionBase

Implementation of Namespace.instantiateAlarmCondition
- Defined in packages/node-opcua-address-space/src/namespace.ts:1542
Parameters
- alarmConditionTypeId: UAEventType | NodeId | string
- options: any
- data: any
Returns UAAlarmConditionBase

instantiateCondition

instantiateCondition(conditionTypeId: UAEventType | NodeId | string, options: any, data: any): UAConditionBase

Implementation of Namespace.instantiateCondition
- Defined in packages/node-opcua-address-space/src/namespace.ts:1529
Parameters
- conditionTypeId: UAEventType | NodeId | string
- options: any
- data: any
Returns UAConditionBase

instantiateDiscreteAlarm

instantiateDiscreteAlarm(discreteAlarmType: UAEventType | NodeId | string, options: any, data: any): UADiscreteAlarm

Implementation of Namespace.instantiateDiscreteAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1578
Parameters
- discreteAlarmType: UAEventType | NodeId | string
- options: any
- data: any
Returns UADiscreteAlarm

instantiateExclusiveDeviationAlarm

instantiateExclusiveDeviationAlarm(options: any, data: any): UAExclusiveDeviationAlarm

Implementation of Namespace.instantiateExclusiveDeviationAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1562
Parameters
- options: any
- data: any
Returns UAExclusiveDeviationAlarm

instantiateExclusiveLimitAlarm

instantiateExclusiveLimitAlarm(exclusiveLimitAlarmTypeId: UAEventType | NodeId | string, options: any, data: any): UAExclusiveLimitAlarm

Implementation of Namespace.instantiateExclusiveLimitAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1554
Parameters
- exclusiveLimitAlarmTypeId: UAEventType | NodeId | string
- options: any
- data: any
Returns UAExclusiveLimitAlarm

instantiateLimitAlarm

instantiateLimitAlarm(limitAlarmTypeId: UAEventType | NodeId | string, options: any, data: any): UALimitAlarm

Implementation of Namespace.instantiateLimitAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1550
Parameters
- limitAlarmTypeId: UAEventType | NodeId | string
- options: any
- data: any
Returns UALimitAlarm

instantiateNonExclusiveDeviationAlarm

instantiateNonExclusiveDeviationAlarm(options: any, data: any): UANonExclusiveDeviationAlarm

Implementation of Namespace.instantiateNonExclusiveDeviationAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1574
Parameters
- options: any
- data: any
Returns UANonExclusiveDeviationAlarm

instantiateNonExclusiveLimitAlarm

instantiateNonExclusiveLimitAlarm(nonExclusiveLimitAlarmTypeId: UAEventType | NodeId | string, options: any, data: any): UANonExclusiveLimitAlarm

Implementation of Namespace.instantiateNonExclusiveLimitAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1566
Parameters
- nonExclusiveLimitAlarmTypeId: UAEventType | NodeId | string
- options: any
- data: any
Returns UANonExclusiveLimitAlarm

instantiateOffNormalAlarm

instantiateOffNormalAlarm(options: any, data: any): UAOffNormalAlarm

Implementation of Namespace.instantiateOffNormalAlarm
- Defined in packages/node-opcua-address-space/src/namespace.ts:1581
Parameters
- options: any
- data: any
Returns UAOffNormalAlarm

nodeIterator

nodeIterator(): IterableIterator<BaseNode>

- Defined in packages/node-opcua-address-space/src/namespace.ts:253
Returns IterableIterator<BaseNode>

resolveAlias

resolveAlias(name: string): NodeId | null

- Defined in packages/node-opcua-address-space/src/namespace.ts:361
Parameters
- name: string
Returns NodeId | null

toNodeset2XML

toNodeset2XML(): string

Implementation of Namespace.toNodeset2XML
- Defined in packages/node-opcua-address-space/src/namespace.ts:1398
Returns string

Class UANamespace

Hierarchy

Implements

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: any

Returns UANamespace

Properties

addressSpace

Readonly index

Readonly namespaceUri

publicationDate

version

Static _handle_hierarchy_parent

Static isNonEmptyQualifiedName

Methods

_aliasCount

Returns number

_createNode

Parameters

options: CreateNodeOptions

Returns BaseNode

_dataTypeCount

Returns number

_dataTypeIterator

Returns IterableIterator<UADataType>

_deleteNode

Parameters

node: BaseNode

Returns void

_objectTypeCount

Returns number

_objectTypeIterator

Returns IterableIterator<UAObjectType>

_referenceTypeCount

Returns number

_referenceTypeIterator

Returns IterableIterator<UAReferenceType>

_register

Parameters

node: BaseNode

Returns void

_variableTypeCount

Returns number

_variableTypeIterator

Returns IterableIterator<UAVariableType>

addAlias

Parameters

alias_name: string

nodeId: NodeId

Returns void

addAnalogDataItem

Parameters

options: AddAnalogDataItemOptions

Returns UAAnalogItem

addDataItem

Parameters

options: AddDataItemOptions

Returns UADataItem

addEnumerationType

Parameters

options: AddEnumerationTypeOptions

Returns UADataType

addEventType

Parameters

options: any

Returns UAObjectType

addFolder

Parameters

parentFolder: UAObject

options: AddFolderOptions | string

Returns UAObject

addMethod

Parameters

parentObject: UAObject

options: AddMethodOptions