Interface UAVariableT<T, DT>

interface UAVariableT<T, DT extends DataType> {
    $extensionObject?: any;
    accessLevel: number;
    arrayDimensions: number[] | null;
    browseName: QualifiedName;
    dataType: NodeId;
    dataTypeObj: UADataType;
    historizing: boolean;
    minimumSamplingInterval: number;
    nodeClass: Variable;
    nodeId: NodeId;
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
    parent: BaseNode<BaseNodeEvents> | null;
    semantic_version: number;
    userAccessLevel?: number;
    valueRank: number;
    get accessRestrictions(): AccessRestrictionsFlag | undefined;
    get addressSpace(): IAddressSpace;
    get description(): LocalizedText;
    get displayName(): LocalizedText[];
    get modellingRule(): ModellingRuleType | undefined;
    get namespace(): INamespace;
    get namespaceIndex(): number;
    get namespaceUri(): string;
    get parentNodeId(): NodeId | undefined;
    get rolePermissions(): RolePermissionType[] | undefined;
    get typeDefinition(): NodeId;
    get typeDefinitionObj(): UAVariableType;
    addReference(options: AddReferenceOpts): void;
    allReferences(): UAReference[];
    asyncRefresh(
        oldestDate: PreciseClock,
        callback: CallbackT<DataValue>,
    ): void;
    asyncRefresh(oldestDate: PreciseClock): Promise<DataValue>;
    bindExtensionObject(
        optionalExtensionObject?: ExtensionObject | ExtensionObject[],
        options?: BindExtensionObjectOptions,
    ): ExtensionObject | ExtensionObject[] | null;
    bindExtensionObjectArray(
        optionalExtensionObjectArray?: ExtensionObject[],
        options?: BindExtensionObjectOptions,
    ): ExtensionObject[] | null;
    bindExtensionObjectScalar(
        optionalExtensionObject?: ExtensionObject,
        options?: BindExtensionObjectOptions,
    ): ExtensionObject | null;
    bindVariable(options?: BindVariableOptions, overwrite?: boolean): void;
    browseNode(
        browseDescription: BrowseDescriptionOptions2,
        session?: ISessionContext,
    ): ReferenceDescription[];
    browseNodeByTargetName(
        relativePathElement: RelativePathElement,
        isLast: boolean,
    ): NodeId[];
    changeDataType(newDataType: NodeIdLike, newValue?: VariantOptions): void;
    clone(
        options: CloneOptions,
        optionalFilter?: CloneFilter,
        extraInfo?: CloneExtraInfo,
    ): UAVariable;
    emit<K extends keyof UAVariableEvents>(
        event: K,
        ...args: Parameters<UAVariableEvents[K]>,
    ): boolean;
    findReference(
        referenceType: string | NodeId | UAReferenceType,
        isForward?: boolean,
    ): UAReference | null;
    findReferences(
        referenceType: string | NodeId | UAReferenceType,
        isForward?: boolean,
    ): UAReference[];
    findReferencesAsObject(
        referenceType: string | NodeId | UAReferenceType,
        isForward?: boolean,
    ): BaseNode<BaseNodeEvents>[];
    findReferencesEx(
        referenceType: string | NodeId | UAReferenceType,
        browseDirection?: BrowseDirection,
    ): UAReference[];
    findReferencesExAsObject(
        referenceType: string | NodeId | UAReferenceType,
        browseDirection?: BrowseDirection,
    ): BaseNode<BaseNodeEvents>[];
    fullName(): string;
    getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
    getAggregates(): BaseNode<BaseNodeEvents>[];
    getBasicDataType(): DataType;
    getChildByName(
        browseName: QualifiedNameOptions,
    ): BaseNode<BaseNodeEvents> | null;
    getChildByName(
        browseName: string,
        namespaceIndex?: number,
    ): BaseNode<BaseNodeEvents> | null;
    getComponentByName(
        componentName: QualifiedNameOptions,
    ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
    getComponentByName(
        componentName: string,
        namespaceIndex?: number,
    ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
    getComponents(): BaseNode<BaseNodeEvents>[];
    getDisplayName(locale?: string): string;
    getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
    getEventSources(): BaseNode<BaseNodeEvents>[];
    getNodeVersion(): UAProperty<UAString, String> | null;
    getNotifiers(): BaseNode<BaseNodeEvents>[];
    getProperties(): BaseNode<BaseNodeEvents>[];
    getPropertyByName(
        propertyName: QualifiedNameOptions,
    ): UAVariable<UAVariableEvents> | null;
    getPropertyByName(
        propertyName: string,
        namespaceIndex?: number,
    ): UAVariable<UAVariableEvents> | null;
    getRolePermissions(inherited: boolean): RolePermissionType[] | null;
    historyRead(
        context: ISessionContext,
        historyReadDetails:
            | HistoryReadDetails
            | ReadAtTimeDetails
            | ReadEventDetails
            | ReadProcessedDetails
            | ReadRawModifiedDetails,
        indexRange: NumericRange | null,
        dataEncoding: QualifiedNameLike | null,
        continuationData: ContinuationData,
    ): Promise<HistoryReadResult>;
    historyRead(
        context: ISessionContext,
        historyReadDetails:
            | HistoryReadDetails
            | ReadAtTimeDetails
            | ReadEventDetails
            | ReadProcessedDetails
            | ReadRawModifiedDetails,
        indexRange: NumericRange | null,
        dataEncoding: QualifiedNameLike | null,
        continuationData: ContinuationData,
        callback: CallbackT<HistoryReadResult>,
    ): void;
    install_extra_properties(): void;
    installExtensionObjectVariables(): void;
    isDisposed(): boolean;
    isEnumeration(): boolean;
    isExtensionObject(): boolean;
    isReadable(context: ISessionContext): boolean;
    isUserReadable(context: ISessionContext): boolean;
    isUserWritable(context: ISessionContext): boolean;
    isWritable(context: ISessionContext): boolean;
    listenerCount<K extends keyof UAVariableEvents>(event: K): number;
    off<K extends keyof UAVariableEvents>(
        event: K,
        listener: UAVariableEvents[K],
    ): this;
    on<K extends keyof UAVariableEvents>(
        event: K,
        listener: UAVariableEvents[K],
    ): this;
    once<K extends keyof UAVariableEvents>(
        event: K,
        listener: UAVariableEvents[K],
    ): this;
    readAttribute(
        context: ISessionContext | null,
        attributeId: AttributeIds,
        indexRange?: NumericRange,
        dataEncoding?: QualifiedNameLike | null,
    ): DataValue;
    readEnumValue(): EnumValue2;
    readValue(
        context?: ISessionContext | null,
        indexRange?: NumericRange,
        dataEncoding?: QualifiedNameLike | null,
    ): DataValueT<T, DT>;
    readValueAsync(context: ISessionContext | null): Promise<DataValueT<T, DT>>;
    readValueAsync(
        context: ISessionContext | null,
        callback: CallbackT<DataValueT<T, DT>>,
    ): void;
    removeAllListeners(): void;
    removeListener<K extends keyof UAVariableEvents>(
        event: K,
        listener: UAVariableEvents[K],
    ): void;
    removeReference(referenceOpts: AddReferenceOpts): void;
    setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
    setDescription(value: LocalizedTextLike | null): void;
    setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
    setMaxListeners(n: number): void;
    setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
    setValueFromSource(
        value: VariantOptions,
        statusCode?: StatusCode,
        sourceTimestamp?: Date,
    ): void;
    touchValue(updateNow?: PreciseClock): void;
    writeAttribute(
        context: ISessionContext | null,
        writeValue: WriteValueOptions,
        callback: StatusCodeCallback,
    ): void;
    writeAttribute(
        context: ISessionContext | null,
        writeValue: WriteValueOptions,
    ): Promise<StatusCode>;
    writeEnumValue(value: string | number): void;
    writeValue(
        context: ISessionContext,
        dataValue: DataValueT<T, DT>,
        indexRange: NumericRange | null,
        callback: StatusCodeCallback,
    ): void;
    writeValue(
        context: ISessionContext,
        dataValue: DataValueT<T, DT>,
        callback: StatusCodeCallback,
    ): void;
    writeValue(
        context: ISessionContext,
        dataValue: DataValueT<T, DT>,
        indexRange?: NumericRange | null,
    ): Promise<StatusCode>;
}

Type Parameters

T
DT extends DataType

Hierarchy (View Summary)

UAVariable
- UAVariableT
  - UAProperty_Base
  - UAProperty

Index

Properties

`Optional`$extensionObject

$extensionObject?: any

accessLevel

accessLevel: number

The AccessLevel Attribute is used to indicate how the Value of a Variable can be accessed (read/write) and if it contains current and/or historic data.

The AccessLevel does not take any user access rights into account, i.e. although the Variable is writable this may be restricted to a certain user / user group.

The {{link:AccessLevelType}}

arrayDimensions

arrayDimensions: number[] | null

This Attribute specifies the length of each dimension for an array value.

The Attribute is intended to describe the capability of the Variable, not the current size.
The number of elements shall be equal to the value of the valueRank Attribute.
Shall be null if valueRank <=0.
A value of 0 for an individual dimension indicates that the dimension has a variable length.

example

For example, if a Variable is defined by the following javascript array with 346 Int32 elements:

const myArray = new Array(346).fill(0);

then:

DataType would point to an Int32
the Variable's valueRank has the value 1 and,
the arrayDimensions is an array with one entry having the value 346.

{
  dataType: "Int32",
  valueRank: 1,
  arrayDimensions: [346]
}

Note: the maximum length of an array transferred on the wire is 2147483647 (max Int32) and a multidimensional array is encoded as a one dimensional array.

`Readonly`browseName

browseName: QualifiedName

dataType

dataType: NodeId

`Readonly`dataTypeObj

dataTypeObj: UADataType

historizing

historizing: boolean

The historizing attribute indicates whether the server is actively collecting data for the history of the variable.

This differs from the accessLevel Attribute which identifies if the variable has any historical data.

A value of true indicates that the server is actively collecting data.

A value of false indicates the server is not actively collecting data.

Default value is false.

minimumSamplingInterval

minimumSamplingInterval: number

The MinimumSamplingInterval Attribute indicates how 'current' the Value of the Variable will be kept.

It specifies (in milliseconds) how fast the Server can reasonably sample the value for changes (see Part 4 for a detailed description of sampling interval).

A MinimumSamplingInterval of 0 indicates that the Server is to monitor the item continuously.

A MinimumSamplingInterval of -1 means indeterminate.

`Readonly`nodeClass

nodeClass: Variable

`Readonly`nodeId

nodeId: NodeId

`Optional`onFirstBrowseAction

onFirstBrowseAction?: (this: BaseNode) => Promise<void>

`Readonly`parent

parent: BaseNode<BaseNodeEvents> | null

semantic_version

semantic_version: number

`Optional`userAccessLevel

userAccessLevel?: number

The UserAccessLevel Attribute is used to indicate how the Value of a Variable can be accessed (read/write) and if it contains current or historic data taking user access rights into account.

The AccessLevelType is defined in 8.57.

valueRank

valueRank: number

This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions the array has. It may have the following values:

n > 1 : the Value is an array with the specified number of dimensions.
OneDimension (1): The value is an array with one dimension.
OneOrMoreDimensions (0): The value is an array with one or more dimensions.
Scalar (-1): The value is not an array.
Any (-2): The value can be a scalar or an array with any number of dimensions.
ScalarOrOneDimension (-3): The value can be a scalar or a one dimensional array.

NOTE:

All DataTypes are considered to be scalar, even if they have array-like semantics like ByteString and String.

Accessors

accessRestrictions

get accessRestrictions(): AccessRestrictionsFlag | undefined
Returns AccessRestrictionsFlag | undefined
Inherited from BaseNode.accessRestrictions
- Defined in node-opcua-address-space-base/source/base_node.ts:151

addressSpace

get addressSpace(): IAddressSpace
Returns IAddressSpace
Inherited from BaseNode.addressSpace
- Defined in node-opcua-address-space-base/source/base_node.ts:144

description

get description(): LocalizedText
Returns LocalizedText
Inherited from BaseNode.description
- Defined in node-opcua-address-space-base/source/base_node.ts:147

displayName

get displayName(): LocalizedText[]
Returns LocalizedText[]
Inherited from BaseNode.displayName
- Defined in node-opcua-address-space-base/source/base_node.ts:146

modellingRule

get modellingRule(): ModellingRuleType | undefined
Returns ModellingRuleType | undefined
Inherited from BaseNode.modellingRule
- Defined in node-opcua-address-space-base/source/base_node.ts:149

namespace

get namespace(): INamespace
Returns INamespace
Inherited from BaseNode.namespace
- Defined in node-opcua-address-space-base/source/base_node.ts:157

namespaceIndex

get namespaceIndex(): number
Returns number
Inherited from BaseNode.namespaceIndex
- Defined in node-opcua-address-space-base/source/base_node.ts:155

namespaceUri

get namespaceUri(): string
Returns string
Inherited from BaseNode.namespaceUri
- Defined in node-opcua-address-space-base/source/base_node.ts:156

parentNodeId

get parentNodeId(): NodeId | undefined
Returns NodeId | undefined
Inherited from BaseNode.parentNodeId
- Defined in node-opcua-address-space-base/source/base_node.ts:150

rolePermissions

get rolePermissions(): RolePermissionType[] | undefined
Returns RolePermissionType[] | undefined
Inherited from BaseNode.rolePermissions
- Defined in node-opcua-address-space-base/source/base_node.ts:152

typeDefinition

get typeDefinition(): NodeId
Returns NodeId
Inherited from UAVariable.typeDefinition
- Defined in node-opcua-address-space-base/source/ua_variable.ts:108

typeDefinitionObj

get typeDefinitionObj(): UAVariableType
Returns UAVariableType
Inherited from UAVariable.typeDefinitionObj
- Defined in node-opcua-address-space-base/source/ua_variable.ts:107

Methods

addReference

addReference(options: AddReferenceOpts): void
Parameters
- options: AddReferenceOpts
Returns void
Inherited from UAVariable.addReference
- Defined in node-opcua-address-space-base/source/base_node.ts:169

allReferences

allReferences(): UAReference[]
Returns UAReference[]
Inherited from UAVariable.allReferences
- Defined in node-opcua-address-space-base/source/base_node.ts:259

asyncRefresh

asyncRefresh(oldestDate: PreciseClock, callback: CallbackT<DataValue>): void
Parameters
- oldestDate: PreciseClock
- callback: CallbackT<DataValue>
Returns void
Inherited from UAVariable.asyncRefresh
- Defined in node-opcua-address-space-base/source/ua_variable.ts:303
asyncRefresh(oldestDate: PreciseClock): Promise<DataValue>
Parameters
- oldestDate: PreciseClock
Returns Promise<DataValue>
Inherited from UAVariable.asyncRefresh
- Defined in node-opcua-address-space-base/source/ua_variable.ts:305

bindExtensionObject

bindExtensionObject(
optionalExtensionObject?: ExtensionObject | ExtensionObject[],
options?: BindExtensionObjectOptions,
): ExtensionObject | ExtensionObject[] | null
Parameters
- OptionaloptionalExtensionObject: ExtensionObject | ExtensionObject[]
- Optionaloptions: BindExtensionObjectOptions
Returns ExtensionObject | ExtensionObject[] | null
Inherited from UAVariable.bindExtensionObject
- Defined in node-opcua-address-space-base/source/ua_variable.ts:368

bindExtensionObjectArray

bindExtensionObjectArray(
optionalExtensionObjectArray?: ExtensionObject[],
options?: BindExtensionObjectOptions,
): ExtensionObject[] | null
Parameters
- OptionaloptionalExtensionObjectArray: ExtensionObject[]
- Optionaloptions: BindExtensionObjectOptions
Returns ExtensionObject[] | null
Inherited from UAVariable.bindExtensionObjectArray
- Defined in node-opcua-address-space-base/source/ua_variable.ts:378

bindExtensionObjectScalar

bindExtensionObjectScalar(
optionalExtensionObject?: ExtensionObject,
options?: BindExtensionObjectOptions,
): ExtensionObject | null
Parameters
- OptionaloptionalExtensionObject: ExtensionObject
- Optionaloptions: BindExtensionObjectOptions
Returns ExtensionObject | null
Inherited from UAVariable.bindExtensionObjectScalar
- Defined in node-opcua-address-space-base/source/ua_variable.ts:373

bindVariable

bindVariable(options?: BindVariableOptions, overwrite?: boolean): void
Parameters
- Optionaloptions: BindVariableOptions
- Optionaloverwrite: boolean
Returns void
Inherited from UAVariable.bindVariable
- Defined in node-opcua-address-space-base/source/ua_variable.ts:366

browseNode

browseNode(
browseDescription: BrowseDescriptionOptions2,
session?: ISessionContext,
): ReferenceDescription[]
browse the node to extract information requested in browseDescription
Parameters
- browseDescription: BrowseDescriptionOptions2
- Optionalsession: ISessionContext
Returns ReferenceDescription[]
Inherited from UAVariable.browseNode
- Defined in node-opcua-address-space-base/source/base_node.ts:281

browseNodeByTargetName

browseNodeByTargetName(
relativePathElement: RelativePathElement,
isLast: boolean,
): NodeId[]
Parameters
- relativePathElement: RelativePathElement
- isLast: boolean
Returns NodeId[]
Inherited from UAVariable.browseNodeByTargetName
- Defined in node-opcua-address-space-base/source/base_node.ts:209

changeDataType

changeDataType(newDataType: NodeIdLike, newValue?: VariantOptions): void
Parameters
- newDataType: NodeIdLike
- OptionalnewValue: VariantOptions
Returns void
Inherited from UAVariable.changeDataType
- Defined in node-opcua-address-space-base/source/ua_variable.ts:89

clone

clone(
    options: CloneOptions,
    optionalFilter?: CloneFilter,
    extraInfo?: CloneExtraInfo,
): UAVariable
Parameters
- options: CloneOptions
- OptionaloptionalFilter: CloneFilter
- OptionalextraInfo: CloneExtraInfo
Returns UAVariable
Inherited from UAVariable.clone
- Defined in node-opcua-address-space-base/source/ua_variable.ts:412

emit

emit<K extends keyof UAVariableEvents>(
event: K,
...args: Parameters<UAVariableEvents[K]>,
): boolean
Type Parameters
- K extends keyof UAVariableEvents
Parameters
- event: K
- ...args: Parameters<UAVariableEvents[K]>
Returns boolean
Inherited from UAVariable.emit
- Defined in node-opcua-address-space-base/source/base_node.ts:124

findReference

findReference(
referenceType: string | NodeId | UAReferenceType,
isForward?: boolean,
): UAReference | null
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
- OptionalisForward: boolean
Returns UAReference | null
Inherited from UAVariable.findReference
- Defined in node-opcua-address-space-base/source/base_node.ts:237

findReferences

findReferences(
referenceType: string | NodeId | UAReferenceType,
isForward?: boolean,
): UAReference[]
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
- OptionalisForward: boolean
Returns UAReference[]
Inherited from UAVariable.findReferences
- Defined in node-opcua-address-space-base/source/base_node.ts:225

findReferencesAsObject

findReferencesAsObject(
referenceType: string | NodeId | UAReferenceType,
isForward?: boolean,
): BaseNode<BaseNodeEvents>[]
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
- OptionalisForward: boolean
Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.findReferencesAsObject
- Defined in node-opcua-address-space-base/source/base_node.ts:257

findReferencesEx

findReferencesEx(
referenceType: string | NodeId | UAReferenceType,
browseDirection?: BrowseDirection,
): UAReference[]
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
- OptionalbrowseDirection: BrowseDirection
Returns UAReference[]
Inherited from UAVariable.findReferencesEx
- Defined in node-opcua-address-space-base/source/base_node.ts:217

findReferencesExAsObject

findReferencesExAsObject(
referenceType: string | NodeId | UAReferenceType,
browseDirection?: BrowseDirection,
): BaseNode<BaseNodeEvents>[]
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
- OptionalbrowseDirection: BrowseDirection
Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.findReferencesExAsObject
- Defined in node-opcua-address-space-base/source/base_node.ts:245

fullName

fullName(): string
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string
Inherited from UAVariable.fullName
- Defined in node-opcua-address-space-base/source/base_node.ts:167

getAccessRestrictions

getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag
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
Inherited from UAVariable.getAccessRestrictions
- Defined in node-opcua-address-space-base/source/base_node.ts:303

getAggregates

getAggregates(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.getAggregates
- Defined in node-opcua-address-space-base/source/base_node.ts:324

getBasicDataType

getBasicDataType(): DataType
returns the basic type of the variable that correspond to the dataType, that will be used in the dataValue.value.dataType property.

Returns DataType
Inherited from UAVariable.getBasicDataType
- Defined in node-opcua-address-space-base/source/ua_variable.ts:117

getChildByName

getChildByName(
browseName: QualifiedNameOptions,
): BaseNode<BaseNodeEvents> | null
Get the Child by name, if browseName is string and namespaceIndex undefined then the search doesn't care about namespace matching
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode<BaseNodeEvents> | null
Inherited from UAVariable.getChildByName
- Defined in node-opcua-address-space-base/source/base_node.ts:267
getChildByName(
browseName: string,
namespaceIndex?: number,
): BaseNode<BaseNodeEvents> | null
Parameters
- browseName: string
- OptionalnamespaceIndex: number
Returns BaseNode<BaseNodeEvents> | null
Inherited from UAVariable.getChildByName
- Defined in node-opcua-address-space-base/source/base_node.ts:268

getComponentByName

getComponentByName(
componentName: QualifiedNameOptions,
): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Parameters
- componentName: QualifiedNameOptions
Returns UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Inherited from UAVariable.getComponentByName
- Defined in node-opcua-address-space-base/source/base_node.ts:60
getComponentByName(
componentName: string,
namespaceIndex?: number,
): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Parameters
- componentName: string
- OptionalnamespaceIndex: number
Returns UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null
Inherited from UAVariable.getComponentByName
- Defined in node-opcua-address-space-base/source/base_node.ts:61

getComponents

getComponents(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.getComponents
- Defined in node-opcua-address-space-base/source/base_node.ts:68

getDisplayName

getDisplayName(locale?: string): string
Parameters
- Optionallocale: string
  the locale of the text to return (e.g. en-EN)
Returns string
Inherited from UAVariable.getDisplayName
- Defined in node-opcua-address-space-base/source/base_node.ts:202

getEventSourceOfs

getEventSourceOfs(): BaseNode<BaseNodeEvents>[]
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.getEventSourceOfs
- Defined in node-opcua-address-space-base/source/base_node.ts:196

getEventSources

getEventSources(): BaseNode<BaseNodeEvents>[]
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.getEventSources
- Defined in node-opcua-address-space-base/source/base_node.ts:190

getNodeVersion

getNodeVersion(): UAProperty<UAString, String> | null
return the versioning node

Returns UAProperty<UAString, String> | null
Inherited from UAVariable.getNodeVersion
- Defined in node-opcua-address-space-base/source/base_node.ts:319

getNotifiers

getNotifiers(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.getNotifiers
- Defined in node-opcua-address-space-base/source/base_node.ts:72

getProperties

getProperties(): BaseNode<BaseNodeEvents>[]
Returns BaseNode<BaseNodeEvents>[]
Inherited from UAVariable.getProperties
- Defined in node-opcua-address-space-base/source/base_node.ts:70

getPropertyByName

getPropertyByName(
propertyName: QualifiedNameOptions,
): UAVariable<UAVariableEvents> | null
Parameters
- propertyName: QualifiedNameOptions
Returns UAVariable<UAVariableEvents> | null
Inherited from UAVariable.getPropertyByName
- Defined in node-opcua-address-space-base/source/base_node.ts:63
getPropertyByName(
propertyName: string,
namespaceIndex?: number,
): UAVariable<UAVariableEvents> | null
Parameters
- propertyName: string
- OptionalnamespaceIndex: number
Returns UAVariable<UAVariableEvents> | null
Inherited from UAVariable.getPropertyByName
- Defined in node-opcua-address-space-base/source/base_node.ts:64

getRolePermissions

getRolePermissions(inherited: boolean): RolePermissionType[] | null
Parameters
- inherited: boolean
Returns RolePermissionType[] | null
Inherited from UAVariable.getRolePermissions
- Defined in node-opcua-address-space-base/source/base_node.ts:289

historyRead

historyRead(
    context: ISessionContext,
    historyReadDetails:
        | HistoryReadDetails
        | ReadAtTimeDetails
        | ReadEventDetails
        | ReadProcessedDetails
        | ReadRawModifiedDetails,
    indexRange: NumericRange | null,
    dataEncoding: QualifiedNameLike | null,
    continuationData: ContinuationData,
): Promise<HistoryReadResult>
Parameters
- context: ISessionContext
- historyReadDetails:
      | HistoryReadDetails
      | ReadAtTimeDetails
      | ReadEventDetails
      | ReadProcessedDetails
      | ReadRawModifiedDetails
- indexRange: NumericRange | null
- dataEncoding: QualifiedNameLike | null
- continuationData: ContinuationData
Returns Promise<HistoryReadResult>
Inherited from UAVariable.historyRead
- Defined in node-opcua-address-space-base/source/ua_variable.ts:385
historyRead(
    context: ISessionContext,
    historyReadDetails:
        | HistoryReadDetails
        | ReadAtTimeDetails
        | ReadEventDetails
        | ReadProcessedDetails
        | ReadRawModifiedDetails,
    indexRange: NumericRange | null,
    dataEncoding: QualifiedNameLike | null,
    continuationData: ContinuationData,
    callback: CallbackT<HistoryReadResult>,
): void
Parameters
- context: ISessionContext
- historyReadDetails:
      | HistoryReadDetails
      | ReadAtTimeDetails
      | ReadEventDetails
      | ReadProcessedDetails
      | ReadRawModifiedDetails
- indexRange: NumericRange | null
- dataEncoding: QualifiedNameLike | null
- continuationData: ContinuationData
- callback: CallbackT<HistoryReadResult>
Returns void
Inherited from UAVariable.historyRead
- Defined in node-opcua-address-space-base/source/ua_variable.ts:398

install_extra_properties

install_extra_properties(): void
private

Returns void
Inherited from UAVariable.install_extra_properties
- Defined in node-opcua-address-space-base/source/base_node.ts:207

installExtensionObjectVariables

installExtensionObjectVariables(): void
Returns void
Inherited from UAVariable.installExtensionObjectVariables
- Defined in node-opcua-address-space-base/source/ua_variable.ts:383

isDisposed

isDisposed(): boolean
Returns boolean
Inherited from UAVariable.isDisposed
- Defined in node-opcua-address-space-base/source/base_node.ts:159

isEnumeration

isEnumeration(): boolean
Returns boolean
Inherited from UAVariable.isEnumeration
- Defined in node-opcua-address-space-base/source/ua_variable.ts:267

isExtensionObject

isExtensionObject(): boolean
Returns boolean
Inherited from UAVariable.isExtensionObject
- Defined in node-opcua-address-space-base/source/ua_variable.ts:269

isReadable

isReadable(context: ISessionContext): boolean
returns true if the accessLevel flag allows the variable to be readable in the specified context.
Parameters
- context: ISessionContext
Returns boolean
Inherited from UAVariable.isReadable
- Defined in node-opcua-address-space-base/source/ua_variable.ts:220

isUserReadable

isUserReadable(context: ISessionContext): boolean
returns true if the userAccessLevel flag allows the variable to be readable in the specified context.
Parameters
- context: ISessionContext
Returns boolean
Inherited from UAVariable.isUserReadable
- Defined in node-opcua-address-space-base/source/ua_variable.ts:226

isUserWritable

isUserWritable(context: ISessionContext): boolean
returns true if the userAccessLevel flag allows the variable to be writeable in the specified context.
Parameters
- context: ISessionContext
Returns boolean
Inherited from UAVariable.isUserWritable
- Defined in node-opcua-address-space-base/source/ua_variable.ts:238

isWritable

isWritable(context: ISessionContext): boolean
returns true if the accessLevel flag allows the variable to be writeable in the specified context.
Parameters
- context: ISessionContext
Returns boolean
Inherited from UAVariable.isWritable
- Defined in node-opcua-address-space-base/source/ua_variable.ts:232

listenerCount

listenerCount<K extends keyof UAVariableEvents>(event: K): number
Type Parameters
- K extends keyof UAVariableEvents
Parameters
- event: K
Returns number
Inherited from UAVariable.listenerCount
- Defined in node-opcua-address-space-base/source/base_node.ts:127

off

off<K extends keyof UAVariableEvents>(
event: K,
listener: UAVariableEvents[K],
): this
Type Parameters
- K extends keyof UAVariableEvents
Parameters
- event: K
- listener: UAVariableEvents[K]
Returns this
Inherited from UAVariable.off
- Defined in node-opcua-address-space-base/source/base_node.ts:125

on

on<K extends keyof UAVariableEvents>(
event: K,
listener: UAVariableEvents[K],
): this
Type Parameters
- K extends keyof UAVariableEvents
Parameters
- event: K
- listener: UAVariableEvents[K]
Returns this
Inherited from UAVariable.on
- Defined in node-opcua-address-space-base/source/base_node.ts:122

once

once<K extends keyof UAVariableEvents>(
event: K,
listener: UAVariableEvents[K],
): this
Type Parameters
- K extends keyof UAVariableEvents
Parameters
- event: K
- listener: UAVariableEvents[K]
Returns this
Inherited from UAVariable.once
- Defined in node-opcua-address-space-base/source/base_node.ts:123

readAttribute

readAttribute(
    context: ISessionContext | null,
    attributeId: AttributeIds,
    indexRange?: NumericRange,
    dataEncoding?: QualifiedNameLike | null,
): DataValue
Parameters
- context: ISessionContext | null
- attributeId: AttributeIds
- OptionalindexRange: NumericRange
- OptionaldataEncoding: QualifiedNameLike | null
Returns DataValue
Inherited from UAVariable.readAttribute
- Defined in node-opcua-address-space-base/source/ua_variable.ts:283

readEnumValue

readEnumValue(): EnumValue2
Returns EnumValue2
Inherited from UAVariable.readEnumValue
- Defined in node-opcua-address-space-base/source/ua_variable.ts:274

readValue

readValue(
    context?: ISessionContext | null,
    indexRange?: NumericRange,
    dataEncoding?: QualifiedNameLike | null,
): DataValueT<T, DT>

from OPC.UA.Spec 1.02 part 4 5.10.2.4 StatusCodes Table 51 defines values for the operation level statusCode contained in the DataValue structure of each values element. Common StatusCodes are defined in Table 166.

Read Operation Level Result Codes

Symbolic Id	Description
BadNodeIdInvalid	The syntax of the node id is not valid.
BadNodeIdUnknown	The node id refers to a node that does not exist in the server address space.
BadAttributeIdInvalid	BadAttributeIdInvalid The attribute is not supported for the specified node.
BadIndexRangeInvalid	The syntax of the index range parameter is invalid.
BadIndexRangeNoData	No data exists within the range of indexes specified.
BadDataEncodingInvalid	The data encoding is invalid. This result is used if no dataEncoding can be applied because an Attribute other than Value was requested or the DataType of the Value Attribute is not a subtype of the Structure DataType.
BadDataEncodingUnsupported	The server does not support the requested data encoding for the node. This result is used if a dataEncoding can be applied but the passed data encoding is not known to the Server.
BadNotReadable	The access level does not allow reading or subscribing to the Node.
BadUserAccessDenied	User does not have permission to perform the requested operation. (table 165)
BadSecurityModeInsufficient	The operation is not permitted over the current secure channel.
BadInsufficientPrivileges	The user does not have enough privileges to perform the requested operation.

Parameters

Optionalcontext: ISessionContext | null
OptionalindexRange: NumericRange
OptionaldataEncoding: QualifiedNameLike | null

Returns DataValueT<T, DT>

readValueAsync

readValueAsync(context: ISessionContext | null): Promise<DataValueT<T, DT>>
Parameters
- context: ISessionContext | null
Returns Promise<DataValueT<T, DT>>
Overrides UAVariable.readValueAsync
- Defined in node-opcua-address-space-base/source/ua_variable_t.ts:16
readValueAsync(
context: ISessionContext | null,
callback: CallbackT<DataValueT<T, DT>>,
): void
Parameters
- context: ISessionContext | null
- callback: CallbackT<DataValueT<T, DT>>
Returns void
Overrides UAVariable.readValueAsync
- Defined in node-opcua-address-space-base/source/ua_variable_t.ts:17

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from UAVariable.removeAllListeners
- Defined in node-opcua-address-space-base/source/base_node.ts:130

removeListener

removeListener<K extends keyof UAVariableEvents>(
event: K,
listener: UAVariableEvents[K],
): void
Type Parameters
- K extends keyof UAVariableEvents
Parameters
- event: K
- listener: UAVariableEvents[K]
Returns void
Inherited from UAVariable.removeListener
- Defined in node-opcua-address-space-base/source/base_node.ts:131

removeReference

removeReference(referenceOpts: AddReferenceOpts): void
Parameters
- referenceOpts: AddReferenceOpts
Returns void
Inherited from UAVariable.removeReference
- Defined in node-opcua-address-space-base/source/base_node.ts:171

setAccessRestrictions

setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void
setAccessRestriction
Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void
Inherited from UAVariable.setAccessRestrictions
- Defined in node-opcua-address-space-base/source/base_node.ts:294

setDescription

setDescription(value: LocalizedTextLike | null): void
Parameters
- value: LocalizedTextLike | null
Returns void
Inherited from UAVariable.setDescription
- Defined in node-opcua-address-space-base/source/base_node.ts:327

setDisplayName

setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void
Parameters
- value: LocalizedTextLike | LocalizedTextLike[]
Returns void
Inherited from UAVariable.setDisplayName
- Defined in node-opcua-address-space-base/source/base_node.ts:326

setMaxListeners

setMaxListeners(n: number): void
Parameters
- n: number
Returns void
Inherited from UAVariable.setMaxListeners
- Defined in node-opcua-address-space-base/source/base_node.ts:129

setRolePermissions

setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void
Inherited from UAVariable.setRolePermissions
- Defined in node-opcua-address-space-base/source/base_node.ts:287

setValueFromSource

setValueFromSource(
    value: VariantOptions,
    statusCode?: StatusCode,
    sourceTimestamp?: Date,
): void
Parameters
- value: VariantOptions
- OptionalstatusCode: StatusCode
- OptionalsourceTimestamp: Date
Returns void
Inherited from UAVariable.setValueFromSource
- Defined in node-opcua-address-space-base/source/ua_variable.ts:290

touchValue

touchValue(updateNow?: PreciseClock): void
Parameters
- OptionalupdateNow: PreciseClock
Returns void
Inherited from UAVariable.touchValue
- Defined in node-opcua-address-space-base/source/ua_variable.ts:364

writeAttribute

writeAttribute(
    context: ISessionContext | null,
    writeValue: WriteValueOptions,
    callback: StatusCodeCallback,
): void

write a variable attribute (callback version)

Parameters

context: ISessionContext | null
writeValue: WriteValueOptions

callback: StatusCodeCallback

example

  const writeValue = {
     attributeId: AttributeIds.Value,
     dataValue: new DataValue({
         statusCode: StatusCodes.Good,
         sourceTimestamp: new Date(),
         value: new Variant({ dataType: DataType.Double, value: 3.14 })
     }),
     nodeId
  };
myVariable.writeAttribute(context,writeValue,(err, statusCode) => {
   if (err) { console.log("Write has failed"); return; }
   console.log("write statusCode = ",statusCode.toString());
});

Returns void

writeAttribute(
context: ISessionContext | null,
writeValue: WriteValueOptions,
): Promise<StatusCode>

write a variable attribute (async/await version)

Parameters

context: ISessionContext | null

writeValue: WriteValueOptions

example

try {
   const writeValue = {
      attributeId: AttributeIds.Value,
      dataValue: new DataValue({
          statusCode: StatusCodes.Good,
          sourceTimestamp: new Date(),
          value: new Variant({ dataType: DataType.Double, value: 3.14 })
      }),
      nodeId
   };
   const statusCode = await myVariable.writeAttribute(context,writeValue);
} catch(err) {
  console.log("Write has failed");
  return;
}
console.log("write statusCode = ", statusCode.toString());

Returns Promise<StatusCode>

writeEnumValue

writeEnumValue(value: string | number): void
precondition: UAVariable must have a dataType deriving from "Enumeration"
Parameters
- value: string | number
Returns void
Inherited from UAVariable.writeEnumValue
- Defined in node-opcua-address-space-base/source/ua_variable.ts:281

writeValue

writeValue(
    context: ISessionContext,
    dataValue: DataValueT<T, DT>,
    indexRange: NumericRange | null,
    callback: StatusCodeCallback,
): void
Parameters
- context: ISessionContext
- dataValue: DataValueT<T, DT>
- indexRange: NumericRange | null
- callback: StatusCodeCallback
Returns void
Overrides UAVariable.writeValue
- Defined in node-opcua-address-space-base/source/ua_variable_t.ts:19
writeValue(
    context: ISessionContext,
    dataValue: DataValueT<T, DT>,
    callback: StatusCodeCallback,
): void
Parameters
- context: ISessionContext
- dataValue: DataValueT<T, DT>
- callback: StatusCodeCallback
Returns void
Overrides UAVariable.writeValue
- Defined in node-opcua-address-space-base/source/ua_variable_t.ts:26
writeValue(
    context: ISessionContext,
    dataValue: DataValueT<T, DT>,
    indexRange?: NumericRange | null,
): Promise<StatusCode>
Parameters
- context: ISessionContext
- dataValue: DataValueT<T, DT>
- OptionalindexRange: NumericRange | null
Returns Promise<StatusCode>
Overrides UAVariable.writeValue
- Defined in node-opcua-address-space-base/source/ua_variable_t.ts:27

Interface UAVariableT<T, DT>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Optional$extensionObject

accessLevel

arrayDimensions

ReadonlybrowseName

dataType

ReadonlydataTypeObj

historizing

minimumSamplingInterval

ReadonlynodeClass

ReadonlynodeId

OptionalonFirstBrowseAction

Readonlyparent

semantic_version

OptionaluserAccessLevel

valueRank

Accessors

accessRestrictions

Returns AccessRestrictionsFlag | undefined

addressSpace

Returns IAddressSpace

description

Returns LocalizedText

displayName

Returns LocalizedText[]

modellingRule

Returns ModellingRuleType | undefined

namespace

Returns INamespace

namespaceIndex

Returns number

namespaceUri

Returns string

parentNodeId

Returns NodeId | undefined

rolePermissions

Returns RolePermissionType[] | undefined

typeDefinition

Returns NodeId

typeDefinitionObj

Returns UAVariableType

Methods

addReference

Parameters

Returns void

allReferences

Returns UAReference[]

asyncRefresh

Parameters

Returns void

Parameters

Returns Promise<DataValue>

bindExtensionObject

Parameters

Returns ExtensionObject | ExtensionObject[] | null

bindExtensionObjectArray

Parameters

Returns ExtensionObject[] | null

bindExtensionObjectScalar

Parameters

Returns ExtensionObject | null

bindVariable

Parameters

Returns void

browseNode

Parameters

Returns ReferenceDescription[]

browseNodeByTargetName

Parameters

Returns NodeId[]

changeDataType

Parameters

Returns void

`Optional`$extensionObject

`Readonly`browseName

`Readonly`dataTypeObj

`Readonly`nodeClass

`Readonly`nodeId

`Optional`onFirstBrowseAction

`Readonly`parent

`Optional`userAccessLevel