UAVariableType | NodeOPCUA reference documentation

Hierarchy

BaseNode
- UAVariableType
  - UAVariableTypeT

Implements

VariableAttributes

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new UAVariableType(options?: EventEmitterOptions): UAVariableType

Inherited from BaseNode.constructor
- Defined in node-opcua-basic-types/node_modules/.pnpm/@types+node@17.0.23/node_modules/@types/node/events.d.ts:74
Parameters
- Optional options: EventEmitterOptions
Returns UAVariableType

Properties

arrayDimensions

arrayDimensions: number[]

Readonly browseName

browseName: QualifiedName

dataType

dataType: NodeId

historizing

historizing: boolean

isAbstract

isAbstract: boolean

minimumSamplingInterval

minimumSamplingInterval: number

Readonly nodeClass

nodeClass: VariableType

Readonly nodeId

nodeId: NodeId

Optional nodeVersion

nodeVersion: UAVariableT<string, String>

NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node. The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property belongs to. Attribute value changes do not cause the NodeVersion to change. Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

- (): Promise<void>
- Returns Promise<void>

Readonly subtypeOf

subtypeOf: NodeId

Readonly subtypeOfObj

subtypeOfObj: UAVariableType

valueRank

valueRank: number

Accessors

accessRestrictions

get accessRestrictions(): AccessRestrictionsFlag

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:64
Returns AccessRestrictionsFlag

addressSpace

get addressSpace(): IAddressSpace

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:56
Returns IAddressSpace

description

get description(): LocalizedText

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:59
Returns LocalizedText

displayName

get displayName(): LocalizedText[]

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:58
Returns LocalizedText[]

modellingRule

get modellingRule(): ModellingRuleType

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:62
Returns ModellingRuleType

namespace

get namespace(): INamespace

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:68
Returns INamespace

namespaceIndex

get namespaceIndex(): number

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:66
Returns number

namespaceUri

get namespaceUri(): string

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:67
Returns string

parentNodeId

get parentNodeId(): NodeId

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:63
Returns NodeId

rolePermissions

get rolePermissions(): RolePermissionType[]

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:65
Returns RolePermissionType[]

Methods

addReference

addReference(options: AddReferenceOpts): void

Inherited from BaseNode.addReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:75
Parameters
- options: AddReferenceOpts
Returns void

allReferences

allReferences(): UAReference[]

Inherited from BaseNode.allReferences
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:142
Returns UAReference[]

browseNode

browseNode(browseDescription: BrowseDescriptionOptions2, session?: ISessionContext): ReferenceDescription[]

Inherited from BaseNode.browseNode
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:155
browse the node to extract information requested in browseDescription

Parameters
- browseDescription: BrowseDescriptionOptions2
- Optional session: ISessionContext
Returns ReferenceDescription[]

browseNodeByTargetName

browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[]

Inherited from BaseNode.browseNodeByTargetName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:98
Parameters
- relativePathElement: RelativePathElement
- isLast: boolean
Returns NodeId[]

findReference

findReference(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference

Inherited from BaseNode.findReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:123
find the the references that are strictly of type reference.

The isForward boolean flag specifies the direction of the references to be looked for.

Forward direction is implied if omitted.
- will throw an exception if more than one reference exists with the referenceType.
- will return null if no reference exists.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference

findReferences

findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]

Inherited from BaseNode.findReferences
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:112
find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

Forward direction is implied if omitted.

Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference[]

findReferencesAsObject

findReferencesAsObject(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): BaseNode[]

Inherited from BaseNode.findReferencesAsObject
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:141
find all the nodes that are referenced by references strictly of type reference.

The isForward boolean flag specifies the direction of the references to be looked for.

Forward direction is implied if omitted.
- will throw an exception if more than one reference exists with the referenceType.
- will return null if no reference exists.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns BaseNode[]

findReferencesEx

findReferencesEx(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): UAReference[]

Inherited from BaseNode.findReferencesEx
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:105
find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection
- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

findReferencesExAsObject(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): BaseNode[]

Inherited from BaseNode.findReferencesExAsObject
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:130
find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection
- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from BaseNode.fullName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:74
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string

getAccessRestrictions

getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag

Inherited from BaseNode.getAccessRestrictions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:174
get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

Parameters
- inherited: boolean
Returns AccessRestrictionsFlag

getAggregates

getAggregates(): BaseNode[]

Inherited from BaseNode.getAggregates
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:185
Returns BaseNode[]

getChildByName

getChildByName(browseName: QualifiedNameOptions): BaseNode
getChildByName(browseName: string, namespaceIndex?: number): BaseNode

Inherited from BaseNode.getChildByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:143
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from BaseNode.getChildByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:144
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getDisplayName

getDisplayName(locale?: string): string

Inherited from BaseNode.getDisplayName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:93
Parameters
- Optional locale: string
  
  the locale of the text to return (e.g. en-EN)
Returns string

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from BaseNode.getEventSourceOfs
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:88
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from BaseNode.getEventSources
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:83
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode[]

getRolePermissions

getRolePermissions(inherited: boolean): RolePermissionType[]

Inherited from BaseNode.getRolePermissions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:161
Parameters
- inherited: boolean
Returns RolePermissionType[]

install_extra_properties

install_extra_properties(): void

Inherited from BaseNode.install_extra_properties
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:97
private

Returns void

instantiate

instantiate(options: InstantiateVariableOptions): UAVariable

- Defined in node-opcua-address-space-base/dist/ua_variable_type.d.ts:35
Parameters
- options: InstantiateVariableOptions
Returns UAVariable

isSupertypeOf

isSupertypeOf(type: NodeIdLike | UAVariableType): boolean

- Defined in node-opcua-address-space-base/dist/ua_variable_type.d.ts:34
Parameters
- type: NodeIdLike | UAVariableType
Returns boolean

readAttribute

readAttribute(context: ISessionContext, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike): DataValue

Inherited from BaseNode.readAttribute
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:77
Parameters
- context: ISessionContext
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike
Returns DataValue

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from BaseNode.removeReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:76
Parameters
- referenceOpts: AddReferenceOpts
Returns void

setAccessRestrictions

setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void

Inherited from BaseNode.setAccessRestrictions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:165
setAccessRestriction

Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void

setRolePermissions

setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void

Inherited from BaseNode.setRolePermissions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:160
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void

writeAttribute

writeAttribute(context: ISessionContext, writeValue: WriteValueOptions, callback: (err: Error, statusCode?: StatusCode) => void): void

Inherited from BaseNode.writeAttribute
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:78
Parameters
- context: ISessionContext
- writeValue: WriteValueOptions
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns UAVariableType

Properties

arrayDimensions

Readonly browseName

dataType

historizing

isAbstract

minimumSamplingInterval

Readonly nodeClass

Readonly nodeId

Optional nodeVersion

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

Readonly subtypeOf

Readonly subtypeOfObj

valueRank

Accessors

accessRestrictions

Returns AccessRestrictionsFlag

addressSpace

Returns IAddressSpace

description

Returns LocalizedText

displayName

Returns LocalizedText[]

modellingRule

Returns ModellingRuleType

namespace

Returns INamespace

namespaceIndex

Returns number

namespaceUri

Returns string

parentNodeId

Returns NodeId

rolePermissions

Returns RolePermissionType[]

Methods

addReference

Parameters

options: AddReferenceOpts

Returns void

allReferences

Returns UAReference[]

browseNode

Parameters

browseDescription: BrowseDescriptionOptions2

Optional session: ISessionContext

Returns ReferenceDescription[]

browseNodeByTargetName

Parameters

relativePathElement: RelativePathElement

isLast: boolean

Returns NodeId[]

findReference

Parameters

referenceType: string | NodeId | UAReferenceType

Optional isForward: boolean

Returns UAReference

findReferences

Parameters

referenceType: string | NodeId | UAReferenceType

Optional isForward: boolean

Returns UAReference[]

findReferencesAsObject

Parameters

referenceType: string | NodeId | UAReferenceType