Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ackedState

ackedState: UATwoStateVariable

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariable

addComment

addComment: UAMethod

branchId

Readonly browseName

browseName: QualifiedName

comment

comment: UAConditionVariable<LocalizedText, LocalizedText>

conditionClassId

conditionClassId: UAVariableT<NodeId, NodeId>

conditionClassName

conditionName

conditionName: UAVariableT<string, String>

Optional confirm

confirm: UAMethod

Optional confirmedState

confirmedState: UATwoStateVariable

disable

disable: UAMethod

enable

enable: UAMethod

enabledState

enabledState: UATwoStateVariable

eventId

eventId: UAVariable

Readonly eventNotifier

eventNotifier: number

eventType

inputNode

lastSeverity

lastSeverity: UAConditionVariable<StatusCode, StatusCode>

localTime

localTime: UAVariableT<any, ExtensionObject>

maxTimeShelved

maxTimeShelved: UAVariable

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>

shelvingState

shelvingState: ShelvingStateMachine

sourceName

sourceName: UAVariableT<string, String>

sourceNode

sourceNode: UAVariableT<NodeId, NodeId>

suppressedOrShelved

suppressedOrShelved: UAVariable

suppressedState

suppressedState: UATwoStateVariable

Readonly symbolicName

symbolicName: string

time

Static MaxDuration

MaxDuration: number
static
property

MaxDuration

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

_acknowledge_branch

_assert_valid

  • _assert_valid(): void

_bubble_up_event

  • _bubble_up_event(eventData: any): void

_calculateConditionInfo

  • method

    _calculateConditionInfo

    example

    var myAlarm = addressSpace.instantiateExclusiveLimitAlarm({...}); myAlarm._calculateConditionInfo = function(stateName,value,oldCondition) { var percent = Math.ceil(value * 100); return new ConditionInfo({ message: "Tank is almost " + percent + "% full", severity: 100, quality: StatusCodes.Good }); };

    Parameters

    • stateData: string

      the new calculated state of the alarm

    • isActive: boolean
    • value: string

      the new value of the limit alarm

    • oldCondition: ConditionInfo

      given for information purpose

    Returns ConditionInfo

    the new condition info

    this method need to be overridden by the instantiate to allow custom message and severity to be set based on specific context of the alarm.

_conditionRefresh

  • _conditionRefresh(_cache?: any): void

_onInputDataValueChange

  • _onInputDataValueChange(newValue: DataValue): void
  • Parameters

    Returns void

_on_child_added

  • _on_child_added(): void

_on_child_removed

  • _on_child_removed(obj: BaseNode): void

_raiseAuditConditionAcknowledgeEvent

_raiseAuditConditionConfirmEvent

_resend_conditionEvents

  • _resend_conditionEvents(): 0 | 1

_signalInitialCondition

  • _signalInitialCondition(): void
  • Returns void

_signalNewCondition

  • _signalNewCondition(stateName: string, isActive?: boolean, value?: string): void
  • Parameters

    • stateName: string
    • Optional isActive: boolean
    • Optional value: string

    Returns void

acknowledgeAndAutoConfirmBranch

activateAlarm

  • activateAlarm(): void
  • method

    activateAlarm

    Returns void

addListener

addReference

  • method

    addReference

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

    or

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

    Parameters

    Returns void

allReferences

autoConfirmBranch

browseNode

browseNodeByTargetName

clone

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

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

    Returns UAObject

conditionOfNode

  • conditionOfNode(): UAVariable | UAObject

createBranch

currentBranch

deactivateAlarm

  • deactivateAlarm(): void
  • method

    deactivateAlarm

    Returns void

deleteBranch

desactivateAlarm

  • desactivateAlarm(): void
  • deprecated

    use deactivateAlarm instead

    Returns void

dispose

  • dispose(): void

dumpXML

emit

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

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

    Returns boolean

eventNames

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

findHierarchicalReferences

findReference

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

findReferences

findReferencesAsObject

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

findReferencesEx

findReferencesExAsObject

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

fullName

  • fullName(): string

getAggregates

  • getAggregates(): BaseNode[]

getBranchCount

  • getBranchCount(): number

getBranchIds

getBranches

getChildByName

getComponentByName

getComponents

  • getComponents(): BaseNode[]

getCurrentConditionInfo

  • Returns ConditionInfo

getDisplayName

  • getDisplayName(locale?: string): string

getEnabledState

  • getEnabledState(): boolean

getEnabledStateAsString

  • getEnabledStateAsString(): string

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]

getFalseSubStates

  • getFalseSubStates(): UAStateVariable[]
  • method

    getFalseSubStates

    Returns UAStateVariable[]

    return an array with the SubStates of this object.

getFolderElementByName

  • getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode

getFolderElements

  • getFolderElements(): BaseNode[]

getInputNodeNode

  • getInputNodeNode(): UAVariable
  • method

    getInputNodeNode

    Returns UAVariable

    return the node in the address space pointed by the inputNode value

    Note: please note the difference between alarm.inputNode

    • alarm.inputNode is a UAVariable property of the alarm object holding the nodeid of the input node in its value.
    • getInputNodeNode() is the UAVariable that contains the value that affects the state of the alarm and whose node id is stored in alarm.inputNode

getInputNodeValue

  • getInputNodeValue(): any
  • method

    getInputNodeValue

    Returns any

getMaxListeners

  • getMaxListeners(): number

getMaxTimeShelved

  • getMaxTimeShelved(): number
  • method

    getMaxTimeShelved

    Returns number

getMethodById

getMethodByName

  • getMethodByName(methodName: string): UAMethod

getMethods

getNotifiers

  • getNotifiers(): BaseNode[]

getProperties

  • getProperties(): BaseNode[]

getPropertyByName

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

getSuppressedOrShelved

  • getSuppressedOrShelved(): boolean
  • method

    getSuppressedOrShelved

    Returns boolean

getTrueSubStates

  • getTrueSubStates(): UAStateVariable[]
  • method

    getTrueSubStates

    Returns UAStateVariable[]

    return an array with the SubStates of this object.

getUserWriteMask

  • getUserWriteMask(): number

getWriteMask

  • getWriteMask(): number

installPostInstallFunc

  • installPostInstallFunc(f: any): void

install_extra_properties

  • install_extra_properties(): void

isSuppressedOrShelved

  • isSuppressedOrShelved(): boolean
  • method

    isSuppressedOrShelved

    Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

listeners

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

off

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns UAAlarmConditionBase

on

once

ownReferences

prependListener

prependOnceListener

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

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

raiseNewBranchState

raiseNewCondition

  • raiseNewCondition(conditionInfo: ConditionInfoOptions): void
  • method

    raiseNewCondition

    Parameters

    • conditionInfo: ConditionInfoOptions

    Returns void

rawListeners

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

readAttribute

removeAllListeners

removeListener

removeReference

resolveNodeId

setLocalTime

setMaxListeners

setMaxTimeShelved

  • setMaxTimeShelved(duration: number): void
  • method

    setMaxTimeShelved

    Parameters

    • duration: number

      ( Duration in Milliseconds)

      note: duration must be greater than 10ms and lesser than 2**31 ms

    Returns void

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

setTime

  • setTime(time: Date): void
  • method

    setTime

    Parameters

    • time: Date

    Returns void

toString

  • toString(): string

uninstall_extra_properties

  • uninstall_extra_properties(reference: Reference): void

unpropagate_back_references

  • unpropagate_back_references(): void

updateState

  • updateState(): void
  • Returns void

writeAttribute

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

Static install_condition_refresh_handle

  • install_condition_refresh_handle(addressSpace: AddressSpacePrivate): void

Static install_method_handle_on_type

  • install_method_handle_on_type(addressSpace: AddressSpacePrivate): void

Static instantiate

Static listenerCount

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

Static makeAttributeEventName

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