Interface UADiscreteAlarmHelper

interface UADiscreteAlarmHelper {
    acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedText | LocalizedTextLike): void;
    activateAlarm(): void;
    autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void;
    conditionOfNode(): null | UAObject | UAVariable;
    createBranch(): ConditionSnapshot;
    currentBranch(): ConditionSnapshot;
    deactivateAlarm(retain?: boolean): void;
    deleteBranch(branch: ConditionSnapshot): void;
    getBranchCount(): number;
    getBranches(): ConditionSnapshot[];
    getBranchIds(): NodeId[];
    getCurrentConditionInfo(): ConditionInfo;
    getEnabledState(): boolean;
    getEnabledStateAsString(): string;
    getInputNodeNode(): null | UAVariable;
    getInputNodeValue(): any;
    getMaxTimeShelved(): number;
    getSuppressedOrShelved(): boolean;
    installInputNodeMonitoring(inputNode: NodeId | BaseNode): void;
    isSuppressedOrShelved(): boolean;
    on(eventName: string, eventHandle: any): this;
    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
    raiseNewBranchState(branch: ConditionSnapshot): void;
    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
    setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode;
    setLocalTime(time: TimeZoneDataType): void;
    setMaxTimeShelved(duration: number): void;
    setReceiveTime(time: Date): void;
    setSourceName(name: string): void;
    setSourceNode(node: NodeId | BaseNode): void;
    setTime(time: Date): void;
    updateState(): void;
}

Hierarchy (view full)

Methods

acknowledgeAndAutoConfirmBranch activateAlarm autoConfirmBranch conditionOfNode createBranch currentBranch deactivateAlarm deleteBranch getBranchCount getBranches getBranchIds getCurrentConditionInfo getEnabledState getEnabledStateAsString getInputNodeNode getInputNodeValue getMaxTimeShelved getSuppressedOrShelved installInputNodeMonitoring isSuppressedOrShelved on raiseConditionEvent raiseNewBranchState raiseNewCondition setEnabledState setLocalTime setMaxTimeShelved setReceiveTime setSourceName setSourceNode setTime updateState

Methods

acknowledgeAndAutoConfirmBranch

activateAlarm

  • activateAlarm(): void

  • Returns void

autoConfirmBranch

conditionOfNode

createBranch

currentBranch

deactivateAlarm

  • deactivateAlarm(retain?): void

  • Parameters

    • Optionalretain: boolean

    Returns void

deleteBranch

  • deleteBranch(branch): void

  • Parameters

    Returns void

getBranchCount

  • getBranchCount(): number

  • Returns number

getBranches

getBranchIds

getCurrentConditionInfo

getEnabledState

  • getEnabledState(): boolean

  • Returns boolean

getEnabledStateAsString

  • getEnabledStateAsString(): string

  • Returns string

getInputNodeNode

getInputNodeValue

  • getInputNodeValue(): any

  • Returns any

getMaxTimeShelved

  • getMaxTimeShelved(): number

  • Returns number

getSuppressedOrShelved

  • getSuppressedOrShelved(): boolean

  • Returns boolean

installInputNodeMonitoring

isSuppressedOrShelved

  • isSuppressedOrShelved(): boolean

  • Returns boolean

on

  • on(eventName, eventHandle): this

  • Parameters

    • eventName: string
    • eventHandle: any

    Returns this

raiseConditionEvent

  • raiseConditionEvent(branch, renewEventId): void

  • Parameters

    Returns void

raiseNewBranchState

raiseNewCondition

setEnabledState

  • setEnabledState(requestedEnabledState, options?): StatusCode

  • Parameters

    • requestedEnabledState: boolean
    • Optionaloptions: ISetStateOptions

    Returns StatusCode

setLocalTime

  • setLocalTime(time): void

  • Parameters

    Returns void

setMaxTimeShelved

  • setMaxTimeShelved(duration): void

  • Parameters

    • duration: number

    Returns void

setReceiveTime

  • setReceiveTime(time): void

  • Parameters

    • time: Date

    Returns void

setSourceName

  • setSourceName(name): void

  • Parameters

    • name: string

    Returns void

setSourceNode

  • setSourceNode(node): void

  • Parameters

    Returns void

setTime

  • setTime(time): void

  • Parameters

    • time: Date

    Returns void

updateState

  • updateState(): void

  • Returns void

Settings

Member Visibility

On This Page

Methods