Namespace | NodeOPCUA reference documentation

Hierarchy

INamespace
INamespaceAlarmAndCondition
INamespaceDataAccess
INamespaceMachineState
- Namespace

Index

Properties

Methods

Properties

addressSpace

addressSpace: IAddressSpace

index

index: number

namespaceUri

namespaceUri: string

publicationDate

publicationDate: Date

version

version: string

Methods

addAlias

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

Inherited from INamespace.addAlias
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:223
Parameters
- aliasName: string
- nodeId: NodeId
Returns void

addAnalogDataItem

addAnalogDataItem<T, DT>(options: AddAnalogDataItemOptions): UAAnalogItem<T, DT>

Inherited from INamespaceDataAccess.addAnalogDataItem
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:36
Type parameters
- T
- DT: DataType
Parameters
- options: AddAnalogDataItemOptions
Returns UAAnalogItem<T, DT>

addDataItem

addDataItem<T, DT>(options: AddDataItemOptions): UADataItem<T, DT>

Inherited from INamespaceDataAccess.addDataItem
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:35
Type parameters
- T
- DT: DataType
Parameters
- options: AddDataItemOptions
Returns UADataItem<T, DT>

addEnumerationType

addEnumerationType(options: AddEnumerationTypeOptions): UADataType

Inherited from INamespace.addEnumerationType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:227
Parameters
- options: AddEnumerationTypeOptions
Returns UADataType

addEventType

addEventType(options: { browseName: QualifiedNameLike; isAbstract?: boolean; subtypeOf?: string | UAEventType }): UAEventType

Inherited from INamespace.addEventType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:251
add a new event type to the address space
example
```
 const evtType = namespace.addEventType({
     browseName: "MyAuditEventType",
     subtypeOf:  "AuditEventType"
 });
 const myConditionType = namespace.addEventType({
     browseName: "MyConditionType",
     subtypeOf:  "ConditionType",
     isAbstract: false
 });
```
Parameters
- options: { browseName: QualifiedNameLike; isAbstract?: boolean; subtypeOf?: string | UAEventType }
  - browseName: QualifiedNameLike
  - Optional isAbstract?: boolean
  - Optional subtypeOf?: string | UAEventType
    
    default
    
    BaseEventType
Returns UAEventType

addFolder

addFolder(parentFolder: NodeIdLike | UAObject, options: any): UAObject

Inherited from INamespace.addFolder
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:232
Parameters
- parentFolder: NodeIdLike | UAObject
- options: any
Returns UAObject

addMethod

addMethod(parent: UAObject | UAObjectType, options: AddMethodOptions): UAMethod

Inherited from INamespace.addMethod
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:262
Parameters
- parent: UAObject | UAObjectType
- options: AddMethodOptions
Returns UAMethod

addMultiStateDiscrete

addMultiStateDiscrete<T, DT>(options: AddMultiStateDiscreteOptions): UAMultiStateDiscreteEx<T, DT>

Inherited from INamespaceDataAccess.addMultiStateDiscrete
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:40
Type parameters
- T
- DT: DataType
Parameters
- options: AddMultiStateDiscreteOptions
Returns UAMultiStateDiscreteEx<T, DT>

addMultiStateValueDiscrete

addMultiStateValueDiscrete<T, DT>(options: AddMultiStateValueDiscreteOptions): UAMultiStateValueDiscreteEx<T, DT>

Inherited from INamespaceDataAccess.addMultiStateValueDiscrete
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:41
Type parameters
- T
- DT: DataType
Parameters
- options: AddMultiStateValueDiscreteOptions
Returns UAMultiStateValueDiscreteEx<T, DT>

addObject

addObject(options: AddObjectOptions): UAObject

Inherited from INamespace.addObject
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:230
Parameters
- options: AddObjectOptions
Returns UAObject

addObjectType

addObjectType(options: AddObjectTypeOptions): UAObjectType

Inherited from INamespace.addObjectType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:224
Parameters
- options: AddObjectTypeOptions
Returns UAObjectType

addReferenceType

addReferenceType(options: AddReferenceTypeOptions): UAReferenceType

Inherited from INamespace.addReferenceType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:226
Parameters
- options: AddReferenceTypeOptions
Returns UAReferenceType

addState

addState(component: UAObject | UAObjectType, stateName: string, stateNumber: number, isInitialState?: boolean): UAState

Inherited from INamespaceMachineState.addState
- Defined in node-opcua-address-space/dist/source/namespace_machine_state.d.ts:5
Parameters
- component: UAObject | UAObjectType
- stateName: string
- stateNumber: number
- Optional isInitialState: boolean
Returns UAState

addTransition

addTransition(component: UAObject | UAObjectType, fromState: string, toState: string, transitionNumber: number): UATransitionEx

Inherited from INamespaceMachineState.addTransition
- Defined in node-opcua-address-space/dist/source/namespace_machine_state.d.ts:6
Parameters
- component: UAObject | UAObjectType
- fromState: string
- toState: string
- transitionNumber: number
Returns UATransitionEx

addTwoStateDiscrete

addTwoStateDiscrete(options: AddTwoStateDiscreteOptions): UATwoStateDiscreteEx

Inherited from INamespaceDataAccess.addTwoStateDiscrete
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:39
Parameters
- options: AddTwoStateDiscreteOptions
Returns UATwoStateDiscreteEx

addTwoStateVariable

addTwoStateVariable(options: AddTwoStateVariableOptions): UATwoStateVariableEx

Inherited from INamespaceDataAccess.addTwoStateVariable
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:38
Parameters
- options: AddTwoStateVariableOptions
Returns UATwoStateVariableEx

addVariable

addVariable(options: AddVariableOptions): UAVariable

Inherited from INamespace.addVariable
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:229
Parameters
- options: AddVariableOptions
Returns UAVariable

addVariableType

addVariableType(options: AddVariableTypeOptions): UAVariableType

Inherited from INamespace.addVariableType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:225
Parameters
- options: AddVariableTypeOptions
Returns UAVariableType

addView

addView(options: AddViewOptions): UAView

Inherited from INamespace.addView
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:231
Parameters
- options: AddViewOptions
Returns UAView

addYArrayItem

addYArrayItem<DT>(options: AddYArrayItemOptions): UAYArrayItemEx<DT>

Inherited from INamespaceDataAccess.addYArrayItem
- Defined in node-opcua-address-space/dist/source/namespace_data_access.d.ts:37
Type parameters
- DT: Float | Double
Parameters
- options: AddYArrayItemOptions
Returns UAYArrayItemEx<DT>

constructNodeId

constructNodeId(options: ConstructNodeIdOptions): NodeId

Inherited from INamespace.constructNodeId
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:215
Parameters
- options: ConstructNodeIdOptions
Returns NodeId

createDataType

createDataType(options: CreateDataTypeOptions): UADataType

Inherited from INamespace.createDataType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:228
Parameters
- options: CreateDataTypeOptions
Returns UADataType

createNode

createNode(options: any): BaseNode

Inherited from INamespace.createNode
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:233
Parameters
- options: any
Returns BaseNode

deleteNode

deleteNode(node: NodeId | BaseNode): void

Inherited from INamespace.deleteNode
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:235
Parameters
- node: NodeId | BaseNode
Returns void

findDataType

findDataType(dataType: string): UADataType

Inherited from INamespace.findDataType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:218
Parameters
- dataType: string
Returns UADataType

findNode

findNode(nodeId: NodeIdLike): BaseNode

Inherited from INamespace.findNode
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:221
Parameters
- nodeId: NodeIdLike
Returns BaseNode

findNode2

findNode2(nodeId: NodeId): BaseNode

Inherited from INamespace.findNode2
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:222
Parameters
- nodeId: NodeId
Returns BaseNode

findObjectType

findObjectType(objectType: string): UAObjectType

Inherited from INamespace.findObjectType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:216
Parameters
- objectType: string
Returns UAObjectType

findReferenceType

findReferenceType(referenceType: string): UAReferenceType

Inherited from INamespace.findReferenceType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:219
Parameters
- referenceType: string
Returns UAReferenceType

findReferenceTypeFromInverseName

findReferenceTypeFromInverseName(referenceType: string): UAReferenceType

Inherited from INamespace.findReferenceTypeFromInverseName
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:220
Parameters
- referenceType: string
Returns UAReferenceType

findVariableType

findVariableType(variableType: string): UAVariableType

Inherited from INamespace.findVariableType
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:217
Parameters
- variableType: string
Returns UAVariableType

getDefaultAccessRestrictions

getDefaultAccessRestrictions(): AccessRestrictionsFlag

Inherited from INamespace.getDefaultAccessRestrictions
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:278
Returns AccessRestrictionsFlag

getDefaultRolePermissions

getDefaultRolePermissions(): RolePermissionType[]

Inherited from INamespace.getDefaultRolePermissions
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:276
Returns RolePermissionType[]

getStandardsNodeIds

getStandardsNodeIds(): { objectTypeIds: {}; referenceTypeIds: {} }

Inherited from INamespace.getStandardsNodeIds
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:267
internals

Returns { objectTypeIds: {}; referenceTypeIds: {} }
- objectTypeIds: {}
  - [key: string]: string
- referenceTypeIds: {}
  - [key: string]: string

instantiateAcknowledgeableCondition

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

Inherited from INamespaceAlarmAndCondition.instantiateAcknowledgeableCondition
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:15
Parameters
- conditionTypeId: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UAAcknowledgeableConditionEx

instantiateAlarmCondition

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

Inherited from INamespaceAlarmAndCondition.instantiateAlarmCondition
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:16
Parameters
- alarmConditionTypeId: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UAAlarmConditionEx

instantiateCondition

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

Inherited from INamespaceAlarmAndCondition.instantiateCondition
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:14
Parameters
- conditionTypeId: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UAConditionEx

instantiateDiscreteAlarm

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

Inherited from INamespaceAlarmAndCondition.instantiateDiscreteAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:22
Parameters
- discreteAlarmType: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UADiscreteAlarmEx

instantiateExclusiveDeviationAlarm

instantiateExclusiveDeviationAlarm(options: any, data?: any): UAExclusiveDeviationAlarmEx

Inherited from INamespaceAlarmAndCondition.instantiateExclusiveDeviationAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:19
Parameters
- options: any
- Optional data: any
Returns UAExclusiveDeviationAlarmEx

instantiateExclusiveLimitAlarm

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

Inherited from INamespaceAlarmAndCondition.instantiateExclusiveLimitAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:18
Parameters
- exclusiveLimitAlarmTypeId: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UAExclusiveLimitAlarmEx

instantiateLimitAlarm

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

Inherited from INamespaceAlarmAndCondition.instantiateLimitAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:17
Parameters
- limitAlarmTypeId: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UALimitAlarmEx

instantiateNonExclusiveDeviationAlarm

instantiateNonExclusiveDeviationAlarm(options: any, data?: any): UANonExclusiveDeviationAlarmEx

Inherited from INamespaceAlarmAndCondition.instantiateNonExclusiveDeviationAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:21
Parameters
- options: any
- Optional data: any
Returns UANonExclusiveDeviationAlarmEx

instantiateNonExclusiveLimitAlarm

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

Inherited from INamespaceAlarmAndCondition.instantiateNonExclusiveLimitAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:20
Parameters
- nonExclusiveLimitAlarmTypeId: string | NodeId | UAEventType
- options: any
- Optional data: any
Returns UANonExclusiveLimitAlarmEx

instantiateOffNormalAlarm

instantiateOffNormalAlarm(options: any, data?: any): UAOffNormalAlarmEx

Inherited from INamespaceAlarmAndCondition.instantiateOffNormalAlarm
- Defined in node-opcua-address-space/dist/source/namespace_alarm_and_condition.d.ts:23
Parameters
- options: any
- Optional data: any
Returns UAOffNormalAlarmEx

internalCreateNode

internalCreateNode(options: any): BaseNode

Inherited from INamespace.internalCreateNode
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:234
Parameters
- options: any
Returns BaseNode

setDefaultAccessRestrictions

setDefaultAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void

Inherited from INamespace.setDefaultAccessRestrictions
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:277
Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void

setDefaultRolePermissions

setDefaultRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void

Inherited from INamespace.setDefaultRolePermissions
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:275
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void

toNodeset2XML

toNodeset2XML(): string

Inherited from INamespace.toNodeset2XML
- Defined in node-opcua-address-space-base/dist/namespace.d.ts:263
Returns string

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

addressSpace

index

namespaceUri

publicationDate

version

Methods

addAlias

Parameters

aliasName: string

nodeId: NodeId

Returns void

addAnalogDataItem

Type parameters

T

DT: DataType

Parameters

options: AddAnalogDataItemOptions

Returns UAAnalogItem<T, DT>

addDataItem

Type parameters

T

DT: DataType

Parameters

options: AddDataItemOptions

Returns UADataItem<T, DT>

addEnumerationType

Parameters

options: AddEnumerationTypeOptions

Returns UADataType

addEventType

Parameters

options: { browseName: QualifiedNameLike; isAbstract?: boolean; subtypeOf?: string | UAEventType }

browseName: QualifiedNameLike

Optional isAbstract?: boolean

Optional subtypeOf?: string | UAEventType

Returns UAEventType

addFolder

Parameters

parentFolder: NodeIdLike | UAObject

options: any

Returns UAObject

addMethod

Parameters

parent: UAObject | UAObjectType

options: AddMethodOptions

Returns UAMethod

addMultiStateDiscrete

Type parameters

T

DT: DataType

Parameters

options: AddMultiStateDiscreteOptions

Returns UAMultiStateDiscreteEx<T, DT>

addMultiStateValueDiscrete

Type parameters

T

DT: DataType

Parameters

options: AddMultiStateValueDiscreteOptions

Returns UAMultiStateValueDiscreteEx<T, DT>

addObject

Parameters

options: AddObjectOptions

Returns UAObject

addObjectType

Parameters

options: AddObjectTypeOptions

Returns UAObjectType

addReferenceType

Parameters

options: AddReferenceTypeOptions

Returns UAReferenceType

addState

Parameters