Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

  • BaseEventType
    • UAConditionBase

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • options: any

    Returns UAConditionBase

Properties

addComment

addComment: UAMethod

branchId

Readonly browseName

browseName: QualifiedName

comment

comment: UAConditionVariable<LocalizedText, LocalizedText>

conditionClassId

conditionClassId: UAVariableT<NodeId, NodeId>

conditionClassName

conditionName

conditionName: UAVariableT<string, String>

disable

disable: UAMethod

enable

enable: UAMethod

enabledState

enabledState: UATwoStateVariable

eventId

eventId: UAVariable

Readonly eventNotifier

eventNotifier: number

eventType

lastSeverity

lastSeverity: UAConditionVariable<StatusCode, StatusCode>

localTime

localTime: UAVariableT<any, ExtensionObject>

message

Readonly nodeClass

nodeClass: Object = ...

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>

quality

quality: UAConditionVariable<StatusCode, StatusCode>

receiveTime

receiveTime: UAVariableT<Date, DateTime>

retain

retain: UAVariableT<boolean, Boolean>

severity

severity: UAVariableT<number, UInt16>

sourceName

sourceName: UAVariableT<string, String>

sourceNode

sourceNode: UAVariableT<NodeId, NodeId>

Readonly symbolicName

symbolicName: string

time

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static defaultSeverity

defaultSeverity: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static typeDefinition

typeDefinition: NodeId

Accessors

addressSpace

  • get addressSpace(): AddressSpacePrivate
  • Returns AddressSpacePrivate

description

  • Returns LocalizedText

  • Parameters

    Returns any

displayName

  • Returns LocalizedText[]

  • Parameters

    Returns any

fromStateNode

  • get fromStateNode(): BaseNode
  • Returns BaseNode

hasMethods

  • get hasMethods(): boolean
  • returns true if the object has some opcua methods

    Returns boolean

isFalseSubStateOf

  • property

    isFalseSubStateOf

    Returns BaseNode

isTrueSubStateOf

  • property

    isTrueSubStateOf

    Returns BaseNode

modellingRule

  • property

    modellingRule

    Returns ModellingRuleType

namespace

  • Returns Namespace

namespaceIndex

  • get namespaceIndex(): number
  • namespace index

    Returns number

namespaceUri

  • get namespaceUri(): string
  • namespace uri

    Returns string

parent

  • the parent node

    Returns BaseNode

parentNodeId

  • Returns NodeId

toStateNode

  • get toStateNode(): BaseNode
  • Returns BaseNode

typeDefinition

  • get typeDefinition(): NodeId
  • returns the nodeId of this node's Type Definition

    Returns NodeId

typeDefinitionObj

  • Returns UAObjectType

Methods

_assert_valid

  • _assert_valid(): void
  • Returns void

_bubble_up_event

  • _bubble_up_event(eventData: any): void
  • Parameters

    • eventData: any

    Returns void

_conditionRefresh

  • _conditionRefresh(_cache?: any): void
  • Parameters

    • Optional _cache: any

    Returns void

_on_child_added

  • _on_child_added(): void
  • Returns void

_on_child_removed

  • _on_child_removed(obj: BaseNode): void
  • Parameters

    • obj: BaseNode

    Returns void

_resend_conditionEvents

  • _resend_conditionEvents(): 0 | 1
  • Returns 0 | 1

addListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

addReference

  • method

    addReference

    example
    view.addReference({ referenceType: "Organizes", nodeId: myDevice });
    

    or

    myDevice1.addReference({ referenceType: "OrganizedBy", nodeId: view });
    

    Parameters

    Returns void

allReferences

  • Returns Reference[]

browseNode

  • browse the node to extract information requested in browseDescription

    method

    browseNode

    Parameters

    Returns ReferenceDescription[]

    an array with reference descriptions

browseNodeByTargetName

  • method

    browseNodeByTargetName

    Parameters

    Returns NodeId[]

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject
  • Parameters

    • options: any
    • Optional optionalFilter: any
    • Optional extraInfo: any

    Returns UAObject

conditionOfNode

  • conditionOfNode(): UAVariable | UAObject
  • method

    conditionOfNode

    Returns UAVariable | UAObject

createBranch

  • method

    createBranch

    Returns ConditionSnapshot

currentBranch

  • method

    currentBranch

    Returns ConditionSnapshot

deleteBranch

  • method

    deleteBranch

    Parameters

    Returns void

dispose

  • dispose(): void
  • the dispose method should be called when the node is no longer used, to release back pointer to the address space and clear caches.

    method

    dispose

    Returns void

dumpXML

  • Parameters

    Returns void

emit

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

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

    Returns boolean

eventNames

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

findHierarchicalReferences

  • Returns UAReference[]

findReference

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

    findReference

    Parameters

    • strReference: string

      the referenceType as a string.

    • Optional isForward: boolean

    Returns UAReference

findReferences

  • method

    findReferences

    Parameters

    • referenceType: string | NodeId | UAReferenceType

      the referenceType as a string.

    • Optional isForward: boolean

    Returns UAReference[]

    an array with references

findReferencesAsObject

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

    • strReference: string
    • Optional isForward: boolean

    Returns BaseNode[]

findReferencesEx

  • Parameters

    Returns UAReference[]

findReferencesExAsObject

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

    Returns BaseNode[]

fullName

  • fullName(): string
  • Returns string

getAggregates

  • getAggregates(): BaseNode[]
  • return an array with the Aggregates of this object.

    Returns BaseNode[]

getBranchCount

  • getBranchCount(): number
  • Returns number

getBranchIds

  • Returns NodeId[]

getBranches

  • Returns ConditionSnapshot[]

getChildByName

  • Parameters

    Returns BaseNode

getComponentByName

  • retrieve a component by name

    Parameters

    Returns UAObject | UAVariable

getComponents

  • getComponents(): BaseNode[]
  • return an array with the components of this object.

    Returns BaseNode[]

getDisplayName

  • getDisplayName(locale?: string): string
  • Parameters

    • Optional locale: string

    Returns string

getEnabledState

  • getEnabledState(): boolean
  • method

    getEnabledState

    Returns boolean

getEnabledStateAsString

  • getEnabledStateAsString(): string
  • method

    getEnabledStateAsString

    Returns string

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]
  • return a array of the objects for which this node is an EventSource

    Returns BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]
  • return a array with the event source of this object.

    Returns BaseNode[]

getFalseSubStates

  • getFalseSubStates(): UAStateVariable[]
  • method

    getFalseSubStates

    Returns UAStateVariable[]

    return an array with the SubStates of this object.

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode
  • retrieve a folder by name

    Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns BaseNode

getFolderElements

  • getFolderElements(): BaseNode[]
  • returns the list of nodes that this folder object organizes

    Returns BaseNode[]

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getMethodById

  • returns the method exposed by this object and with the given nodeId

    Parameters

    Returns UAMethod

getMethodByName

  • getMethodByName(methodName: string): UAMethod
  • Parameters

    • methodName: string

    Returns UAMethod

getMethods

  • Returns UAMethod[]

getNotifiers

  • getNotifiers(): BaseNode[]
  • return a array with the notifiers of this object.

    Returns BaseNode[]

getProperties

  • getProperties(): BaseNode[]
  • return a array with the properties of this object.

    Returns BaseNode[]

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable
  • retrieve a property by name

    Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns UAVariable

getTrueSubStates

  • getTrueSubStates(): UAStateVariable[]
  • method

    getTrueSubStates

    Returns UAStateVariable[]

    return an array with the SubStates of this object.

getUserWriteMask

  • getUserWriteMask(): number
  • Returns number

getWriteMask

  • getWriteMask(): number
  • Returns number

installPostInstallFunc

  • installPostInstallFunc(f: any): void
  • Parameters

    • f: any

    Returns void

install_extra_properties

  • install_extra_properties(): void
  • Returns void

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): UAConditionBase
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

on

  • Parameters

    • eventName: string
    • eventHandler: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

  • Parameters

    Returns UAConditionBase

  • Parameters

    • eventName: "branch_deleted"
    • eventHandler: (branchId: string) => void
        • (branchId: string): void
        • Parameters

          • branchId: string

          Returns void

    Returns UAConditionBase

once

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

ownReferences

  • Returns Reference[]

prependListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

prependOnceListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

propagate_back_references

  • propagate_back_references(): void
  • this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

    Returns void

raiseConditionEvent

  • method

    raiseConditionEvent Raise a Instance Event (see also UAObject#raiseEvent to raise a transient event)

    Parameters

    • branch: ConditionSnapshot

      the condition branch to raise

    • renewEventId: boolean

      true if event Id of the condition branch should be renewed

    Returns void

raiseEvent

  • Raise a transient Event

    Parameters

    Returns void

raiseNewBranchState

  • Parameters

    Returns void

raiseNewCondition

  • raiseNewCondition(conditionInfo: ConditionInfoOptions): void
  • method

    raiseNewCondition

    Parameters

    • conditionInfo: ConditionInfoOptions

    Returns void

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns UAConditionBase

removeListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAConditionBase

removeReference

  • Parameters

    Returns void

resolveNodeId

  • Parameters

    Returns NodeId

setLocalTime

  • method

    setLocalTime (optional)

    Parameters

    Returns void

setMaxListeners

  • Parameters

    • n: number

    Returns UAConditionBase

setReceiveTime

  • setReceiveTime(time: Date): void
  • method

    setReceiveTime

    Parameters

    • time: Date

    Returns void

setSourceName

  • setSourceName(name: string): void
  • method

    setSourceName

    Parameters

    • name: string

    Returns void

setSourceNode

  • setSourceNode(node: NodeId | BaseNode): void
  • method

    setSourceNode

    Parameters

    Returns void

setTime

  • setTime(time: Date): void
  • method

    setTime

    Parameters

    • time: Date

    Returns void

toString

  • toString(): string
  • Returns string

uninstall_extra_properties

  • uninstall_extra_properties(reference: Reference): void
  • Parameters

    Returns void

unpropagate_back_references

  • unpropagate_back_references(): void
  • Undo the effect of propagate_back_references

    Returns void

writeAttribute

  • writeAttribute(context: SessionContext, writeValue: any, callback: (err: Error, statusCode?: StatusCode) => void): void
  • Parameters

    Returns void

Static install_condition_refresh_handle

  • install_condition_refresh_handle(addressSpace: AddressSpacePrivate): void
  • Parameters

    • addressSpace: AddressSpacePrivate

    Returns void

Static instantiate

  • Parameters

    Returns UAConditionBase

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static makeAttributeEventName

  • Parameters

    Returns string

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Static with_condition_method

Generated using TypeDoc