Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StateVariable

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

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}}

Readonly addressSpace

addressSpace: AddressSpace

arrayDimensions

arrayDimensions: number[]

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

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Optional Readonly effectiveDisplayName

effectiveDisplayName: UAVariableT<LocalizedText, LocalizedText>

effective display name

contains a human readable name for the current state of the state machine after taking the state of any SubStateMachines in account. There is no rule specified for which state or sub-state should be used. It is up to the Server and will depend on the semantics of the StateMachineType

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.

id

id: UAVariable

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.

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Optional Readonly name

name: UAVariableT<QualifiedName, QualifiedName>

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Variable

Readonly nodeId

nodeId: NodeId

Optional Readonly number

number: UAVariableT<number, UInt32>

number is an integer which uniquely identifies the current state within the StateMachineType

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Readonly parent

parent: BaseNode

Optional Readonly parentNodeId

parentNodeId: NodeId

Readonly semantic_version

semantic_version: number

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAVariableType

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.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): StateVariable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateVariable

addReference

allReferences

asyncRefresh

bindExtensionObject

bindVariable

browseNode

clone

  • clone(options?: any, optionalFilter?: any, extraInfo?: any): UAVariable

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

findReference

  • findReference(strReference: string, isForward?: boolean): UAReference

findReferences

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]

findReferencesEx

findReferencesExAsObject

fullName

  • fullName(): string

getAggregates

getChildByName

getComponentByName

getComponents

getEventSourceOfs

getEventSources

getMaxListeners

  • getMaxListeners(): number

getNotifiers

getProperties

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable

historyRead

install_extra_properties

  • install_extra_properties(): void

isEnumeration

  • isEnumeration(): boolean

isExtensionObject

  • isExtensionObject(): boolean

isReadable

isUserReadable

isUserWritable

isWritable

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): StateVariable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateVariable

on

once

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): StateVariable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateVariable

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): StateVariable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateVariable

propagate_back_references

  • propagate_back_references(): void

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

readAttribute

readEnumValue

readValue

readValueAsync

removeAllListeners

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): StateVariable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StateVariable

removeReference

setMaxListeners

setPermissions

setValueFromSource

touchValue

writeAttribute

  • write a variable attribute (callback version)

    Parameters

    • context: SessionContext
    • writeValue: WriteValueOptions
    • callback: CallbackT<StatusCode>

      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

  • write a variable attribute (async/await version)

    Parameters

    • context: SessionContext
    • 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

writeValue

Generated using TypeDoc