UALimitAlarmHelper | NodeOPCUA reference documentation

Hierarchy

UAAlarmConditionHelper
- UALimitAlarmHelper
  - UAExclusiveLimitAlarmHelper
  - UALimitAlarmEx

Index

Methods

acknowledgeAndAutoConfirmBranch

acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedText | LocalizedTextLike): void

Inherited from UAAlarmConditionHelper.acknowledgeAndAutoConfirmBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:20
Parameters
- branch: ConditionSnapshot
- comment: LocalizedText | LocalizedTextLike
Returns void

activateAlarm

activateAlarm(): void

Inherited from UAAlarmConditionHelper.activateAlarm
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:10
Returns void

autoConfirmBranch

autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void

Inherited from UAAlarmConditionHelper.autoConfirmBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:19
Parameters
- branch: ConditionSnapshot
- comment: LocalizedTextLike
Returns void

conditionOfNode

conditionOfNode(): UAObject | UAVariable

Inherited from UAAlarmConditionHelper.conditionOfNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:33
Returns UAObject | UAVariable

createBranch

createBranch(): ConditionSnapshot

Inherited from UAAlarmConditionHelper.createBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:25
Returns ConditionSnapshot

currentBranch

currentBranch(): ConditionSnapshot

Inherited from UAAlarmConditionHelper.currentBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:37
Returns ConditionSnapshot

deactivateAlarm

deactivateAlarm(): void

Inherited from UAAlarmConditionHelper.deactivateAlarm
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:11
Returns void

deleteBranch

deleteBranch(branch: ConditionSnapshot): void

Inherited from UAAlarmConditionHelper.deleteBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:26
Parameters
- branch: ConditionSnapshot
Returns void

getBranchCount

getBranchCount(): number

Inherited from UAAlarmConditionHelper.getBranchCount
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:22
Returns number

getBranchIds

getBranchIds(): NodeId[]

Inherited from UAAlarmConditionHelper.getBranchIds
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:24
Returns NodeId[]

getBranches

getBranches(): ConditionSnapshot[]

Inherited from UAAlarmConditionHelper.getBranches
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:23
Returns ConditionSnapshot[]

getCurrentConditionInfo

getCurrentConditionInfo(): ConditionInfo

Inherited from UAAlarmConditionHelper.getCurrentConditionInfo
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:19
Returns ConditionInfo

getEnabledState

getEnabledState(): boolean

Inherited from UAAlarmConditionHelper.getEnabledState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:27
Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

Inherited from UAAlarmConditionHelper.getEnabledStateAsString
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:28
Returns string

getHighHighLimit

getHighHighLimit(): number

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:17
Returns number

getHighLimit

getHighLimit(): number

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:18
Returns number

getInputNodeNode

getInputNodeNode(): UAVariable

Inherited from UAAlarmConditionHelper.getInputNodeNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:16
Returns UAVariable

getInputNodeValue

getInputNodeValue(): any

Inherited from UAAlarmConditionHelper.getInputNodeValue
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:17
Returns any

getLowLimit

getLowLimit(): number

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:19
Returns number

getLowLowLimit

getLowLowLimit(): number

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:20
Returns number

getMaxTimeShelved

getMaxTimeShelved(): number

Inherited from UAAlarmConditionHelper.getMaxTimeShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:15
Returns number

getSuppressedOrShelved

getSuppressedOrShelved(): boolean

Inherited from UAAlarmConditionHelper.getSuppressedOrShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:13
Returns boolean

installInputNodeMonitoring

installInputNodeMonitoring(inputNode: NodeId | BaseNode): void

Inherited from UAAlarmConditionHelper.installInputNodeMonitoring
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:20
Parameters
- inputNode: NodeId | BaseNode
Returns void

isSuppressedOrShelved

isSuppressedOrShelved(): boolean

Inherited from UAAlarmConditionHelper.isSuppressedOrShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:12
Returns boolean

on

on(eventName: string, eventHandler: (...args: any[]) => void): UALimitAlarmHelper
on(eventName: "acknowledged" | "confirmed", eventHandler: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void): UALimitAlarmHelper

Inherited from UAAlarmConditionHelper.on
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:15
Parameters
- eventName: string
- eventHandler: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns UALimitAlarmHelper
Inherited from UAAlarmConditionHelper.on
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:16
Parameters
- eventName: "acknowledged" | "confirmed"
- eventHandler: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void
  - - (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot): void
    - Parameters
      - eventId: Buffer
      - comment: LocalizedText
      - branch: ConditionSnapshot
      Returns void
Returns UALimitAlarmHelper

raiseConditionEvent

raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void

Inherited from UAAlarmConditionHelper.raiseConditionEvent
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:34
Parameters
- branch: ConditionSnapshot
- renewEventId: boolean
Returns void

raiseNewBranchState

raiseNewBranchState(branch: ConditionSnapshot): void

Inherited from UAAlarmConditionHelper.raiseNewBranchState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:36
Parameters
- branch: ConditionSnapshot
Returns void

raiseNewCondition

raiseNewCondition(conditionInfo: ConditionInfoOptions): void

Inherited from UAAlarmConditionHelper.raiseNewCondition
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:35
Parameters
- conditionInfo: ConditionInfoOptions
Returns void

setEnabledState

setEnabledState(requestedEnabledState: boolean): StatusCode

Inherited from UAAlarmConditionHelper.setEnabledState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:29
Parameters
- requestedEnabledState: boolean
Returns StatusCode

setHighHighLimit

setHighHighLimit(value: number): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:16
Parameters
- value: number
Returns void

setHighLimit

setHighLimit(value: number): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:15
Parameters
- value: number
Returns void

setLocalTime

setLocalTime(time: TimeZoneDataType): void

Inherited from UAAlarmConditionHelper.setLocalTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:31
Parameters
- time: TimeZoneDataType
Returns void

setLowLimit

setLowLimit(value: number): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:14
Parameters
- value: number
Returns void

setLowLowLimit

setLowLowLimit(value: number): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:13
Parameters
- value: number
Returns void

setMaxTimeShelved

setMaxTimeShelved(duration: number): void

Inherited from UAAlarmConditionHelper.setMaxTimeShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:14
Parameters
- duration: number
Returns void

setReceiveTime

setReceiveTime(time: Date): void

Inherited from UAAlarmConditionHelper.setReceiveTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:30
Parameters
- time: Date
Returns void

setSourceName

setSourceName(name: string): void

Inherited from UAAlarmConditionHelper.setSourceName
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_base_event_impl.d.ts:6
Parameters
- name: string
Returns void

setSourceNode

setSourceNode(node: NodeId | BaseNode): void

Inherited from UAAlarmConditionHelper.setSourceNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_base_event_impl.d.ts:7
Parameters
- node: NodeId | BaseNode
Returns void

setTime

setTime(time: Date): void

Inherited from UAAlarmConditionHelper.setTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:32
Parameters
- time: Date
Returns void

updateState

updateState(): void

Inherited from UAAlarmConditionHelper.updateState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:18
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Methods

Methods

acknowledgeAndAutoConfirmBranch

Parameters

branch: ConditionSnapshot

comment: LocalizedText | LocalizedTextLike

Returns void

activateAlarm

Returns void

autoConfirmBranch

Parameters

branch: ConditionSnapshot

comment: LocalizedTextLike

Returns void

conditionOfNode

Returns UAObject | UAVariable

createBranch

Returns ConditionSnapshot

currentBranch

Returns ConditionSnapshot

deactivateAlarm

Returns void

deleteBranch

Parameters

branch: ConditionSnapshot

Returns void

getBranchCount

Returns number

getBranchIds

Returns NodeId[]

getBranches

Returns ConditionSnapshot[]

getCurrentConditionInfo

Returns ConditionInfo

getEnabledState

Returns boolean

getEnabledStateAsString

Returns string

getHighHighLimit

Returns number

getHighLimit

Returns number

getInputNodeNode

Returns UAVariable

getInputNodeValue

Returns any

getLowLimit

Returns number

getLowLowLimit

Returns number

getMaxTimeShelved

Returns number

getSuppressedOrShelved

Returns boolean

installInputNodeMonitoring

Parameters

inputNode: NodeId | BaseNode

Returns void

isSuppressedOrShelved

Returns boolean

on

Parameters

eventName: string

eventHandler: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns UALimitAlarmHelper

Parameters

eventName: "acknowledged" | "confirmed"

eventHandler: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void

Parameters

eventId: Buffer

comment: LocalizedText

branch: ConditionSnapshot

Returns void

Returns UALimitAlarmHelper