UAAlarmConditionHelper | NodeOPCUA reference documentation

Hierarchy

UAAcknowledgeableConditionHelper
- UAAlarmConditionHelper

Index

Methods

acknowledgeAndAutoConfirmBranch

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

Inherited from UAAcknowledgeableConditionHelper.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

- 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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.currentBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:37
Returns ConditionSnapshot

deactivateAlarm

deactivateAlarm(): void

- 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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.getBranches
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:23
Returns ConditionSnapshot[]

getCurrentConditionInfo

getCurrentConditionInfo(): ConditionInfo

- 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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.getEnabledStateAsString
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:28
Returns string

getInputNodeNode

getInputNodeNode(): UAVariable

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

getInputNodeValue

getInputNodeValue(): any

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

getMaxTimeShelved

getMaxTimeShelved(): number

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

getSuppressedOrShelved

getSuppressedOrShelved(): boolean

- 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

- 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

- 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): UAAlarmConditionHelper
on(eventName: "acknowledged" | "confirmed", eventHandler: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void): UAAlarmConditionHelper

Inherited from UAAcknowledgeableConditionHelper.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 UAAlarmConditionHelper
Inherited from UAAcknowledgeableConditionHelper.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 UAAlarmConditionHelper

raiseConditionEvent

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

Inherited from UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.setEnabledState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:29
Parameters
- requestedEnabledState: boolean
Returns StatusCode

setLocalTime

setLocalTime(time: TimeZoneDataType): void

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

setMaxTimeShelved

setMaxTimeShelved(duration: number): void

- 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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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 UAAcknowledgeableConditionHelper.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

- 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

getInputNodeNode

Returns UAVariable

getInputNodeValue

Returns any

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 UAAlarmConditionHelper

Parameters

eventName: "acknowledged" | "confirmed"

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

Parameters

eventId: Buffer

comment: LocalizedText

branch: ConditionSnapshot

Returns void

Returns UAAlarmConditionHelper

raiseConditionEvent

Parameters

branch: ConditionSnapshot

renewEventId: boolean

Returns void

raiseNewBranchState

Parameters

branch: ConditionSnapshot