Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FiniteStateVariable

Hierarchy

Index

Properties

accessLevel

accessLevel: number

addressSpace

addressSpace: AddressSpace

arrayDimensions

arrayDimensions: number[]

browseName

browseName: QualifiedName

dataType

dataType: NodeId

dataTypeObj

dataTypeObj: UADataType

description

description: LocalizedText

displayName

displayName: LocalizedText[]

Optional effectiveDisplayName

effectiveDisplayName: UAVariableT<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

id

id: UAVariableT<NodeId>

Id is inherited from the TransitionVariableType and overridden to reflect the required DataType. This value shall be the NodeId of one of the Transition Objects of the FiniteStateMachineType.

minimumSamplingInterval

minimumSamplingInterval: number

Optional modellingRule

modellingRule: ModellingRuleType

Optional name

name: UAVariableT<QualifiedName>

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Variable

nodeId

nodeId: NodeId

Optional number

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

parent

parent: BaseNode | null

Optional parentNodeId

parentNodeId: NodeId

semantic_version

semantic_version: number

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAVariableType

userAccessLevel

userAccessLevel: number

valueRank

valueRank: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addReference

allReferences

  • allReferences(): Reference[]

asyncRefresh

bindExtensionObject

  • bindExtensionObject(optionalExtensionObject?: ExtensionObject): ExtensionObject | null

bindVariable

browseNode

  • browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]

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(): Array<string | symbol>
  • Returns Array<string | symbol>

findReference

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

findReferences

findReferencesAsObject

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

findReferencesEx

  • findReferencesEx(strReference: string, browseDirection?: BrowseDirection): UAReference[]

findReferencesExAsObject

  • findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

fullName

  • fullName(): string

getAggregates

getChildByName

  • getChildByName(browseName: string | QualifiedName): BaseNode | null

getComponentByName

getComponents

getEventSourceOfs

getEventSources

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getNotifiers

getProperties

getPropertyByName

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

historyRead

install_extra_properties

  • install_extra_properties(): void

isReadable

isUserReadable

isUserWritable

isWritable

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(eventName: "semantic_changed", eventHandler: function): this
  • on(eventName: "value_changed", eventHandler: function): this

once

  • once(eventName: "semantic_changed", eventHandler: function): this
  • once(eventName: "value_changed", eventHandler: function): this

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

propagate_back_references

  • propagate_back_references(): void

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

readEnumValue

readValue

readValueAsync

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeReference

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

setPermissions

setValueFromSource

  • setValueFromSource(value: VariantLike, statusCode?: StatusCode, sourceTimestamp?: Date): void

touchValue

  • touchValue(updateNow?: PreciseClock): void

writeAttribute

writeEnumValue

  • writeEnumValue(value: string | number): void

writeValue

  • writeValue(context: SessionContext, dataValue: DataValueT<LocalizedText>, indexRange: NumericRange | null, callback: function): void
  • writeValue(context: SessionContext, dataValue: DataValueT<LocalizedText>, callback: function): void
  • writeValue(context: SessionContext, dataValue: DataValueT<LocalizedText>, indexRange?: NumericRange | null): Promise<StatusCode>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc