Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UAVector<T>

  subscribe now with sterfive to access the online-user manual

Type parameters

Hierarchy

Index

Properties

Accessors

Methods

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[]

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

parent: BaseNode

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.

Optional vectorUnit

vectorUnit: UAProperty<EUInformation, ExtensionObject>

Accessors

accessRestrictions

addressSpace

  • Returns IAddressSpace

description

  • Returns LocalizedText

displayName

  • Returns LocalizedText[]

modellingRule

  • Returns ModellingRuleType

namespace

  • Returns INamespace

namespaceIndex

  • get namespaceIndex(): number

  • Returns number

namespaceUri

  • get namespaceUri(): string

  • Returns string

parentNodeId

  • Returns NodeId

rolePermissions

  • Returns RolePermissionType[]

typeDefinition

  • get typeDefinition(): NodeId

  • Returns NodeId

typeDefinitionObj

  • Returns UAVariableType

Methods

addReference

allReferences

asyncRefresh

bindExtensionObject

bindVariable

browseNode

browseNodeByTargetName

clone

findReference

  • 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

    Returns UAReference

findReferences

  • 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

    Returns UAReference[]

findReferencesAsObject

  • 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

    Returns BaseNode[]

findReferencesEx

  • 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

    Returns UAReference[]

findReferencesExAsObject

  • 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

    Returns BaseNode[]

fullName

  • fullName(): string

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

    Returns string

getAccessRestrictions

  • 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

getChildByName

getComponentByName

getComponents

getDisplayName

  • getDisplayName(locale?: string): string

  • Parameters

    • Optional locale: string

      the locale of the text to return (e.g. en-EN)

    Returns string

getEventSourceOfs

  • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

    Returns BaseNode[]

getEventSources

  • return a array with the event source of this object. self = HasEventSource => nodes

    Returns BaseNode[]

getNotifiers

getProperties

getPropertyByName

getRolePermissions

historyRead

installExtensionObjectVariables

  • installExtensionObjectVariables(): void

install_extra_properties

  • install_extra_properties(): void

isEnumeration

  • isEnumeration(): boolean

isExtensionObject

  • isExtensionObject(): boolean

isReadable

  • returns true if the accessLevel flag allows the variable to be readable in the specified context.

    Parameters

    Returns boolean

isUserReadable

  • returns true if the userAccessLevel flag allows the variable to be readable in the specified context.

    Parameters

    Returns boolean

isUserWritable

  • returns true if the userAccessLevel flag allows the variable to be writeable in the specified context.

    Parameters

    Returns boolean

isWritable

  • returns true if the accessLevel flag allows the variable to be writeable in the specified context.

    Parameters

    Returns boolean

on

  • on(eventName: "semantic_changed", eventHandler: () => void): UAVector<T>
  • on(eventName: "value_changed", eventHandler: (dataValue: DataValue) => void): UAVector<T>

  • Parameters

    • eventName: "semantic_changed"
    • eventHandler: () => void
        • (): void

        • Returns void

    Returns UAVector<T>

  • Parameters

    • eventName: "value_changed"
    • eventHandler: (dataValue: DataValue) => void

    Returns UAVector<T>

once

  • once(eventName: "semantic_changed", eventHandler: () => void): UAVector<T>
  • once(eventName: "value_changed", eventHandler: (dataValue: DataValue) => void): UAVector<T>

  • Parameters

    • eventName: "semantic_changed"
    • eventHandler: () => void
        • (): void

        • Returns void

    Returns UAVector<T>

  • Parameters

    • eventName: "value_changed"
    • eventHandler: (dataValue: DataValue) => void

    Returns UAVector<T>

readAttribute

readEnumValue

readValue

  • 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

    Returns DataValueT<T, ExtensionObject>

readValueAsync

removeReference

setAccessRestrictions

setRolePermissions

setValueFromSource

touchValue

writeAttribute

  • write a variable attribute (callback version)

    Parameters

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

  • write a variable attribute (async/await version)

    Parameters

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

writeValue

Generated using TypeDoc