Interface UAExclusiveLimitAlarmHelper

interface UAExclusiveLimitAlarmHelper {
    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;
    getHighHighLimit(): number;
    getHighLimit(): number;
    getInputNodeNode(): null | UAVariable;
    getInputNodeValue(): any;
    getLowLimit(): number;
    getLowLowLimit(): number;
    getMaxTimeShelved(): number;
    getSuppressedOrShelved(): boolean;
    installInputNodeMonitoring(inputNode: NodeId | BaseNode): void;
    isSuppressedOrShelved(): boolean;
    on(eventName: string, eventHandler: ((...args: any[]) => void)): this;
    on(eventName: "acknowledged" | "confirmed", eventHandler: ((eventId: null | Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void)): this;
    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
    raiseNewBranchState(branch: ConditionSnapshot): void;
    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
    setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode;
    setHighHighLimit(value: number): void;
    setHighLimit(value: number): void;
    setLocalTime(time: TimeZoneDataType): void;
    setLowLimit(value: number): void;
    setLowLowLimit(value: number): 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 getHighHighLimit getHighLimit getInputNodeNode getInputNodeValue getLowLimit getLowLowLimit getMaxTimeShelved getSuppressedOrShelved installInputNodeMonitoring isSuppressedOrShelved on raiseConditionEvent raiseNewBranchState raiseNewCondition setEnabledState setHighHighLimit setHighLimit setLocalTime setLowLimit setLowLowLimit 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

  • getBranchIds(): NodeId[]

  • Returns NodeId[]

getCurrentConditionInfo

getEnabledState

  • getEnabledState(): boolean

  • Returns boolean

getEnabledStateAsString

  • getEnabledStateAsString(): string

  • Returns string

getHighHighLimit

  • getHighHighLimit(): number

  • Returns number

getHighLimit

  • getHighLimit(): number

  • Returns number

getInputNodeNode

getInputNodeValue

  • getInputNodeValue(): any

  • Returns any

getLowLimit

  • getLowLimit(): number

  • Returns number

getLowLowLimit

  • getLowLowLimit(): number

  • Returns number

getMaxTimeShelved

  • getMaxTimeShelved(): number

  • Returns number

getSuppressedOrShelved

  • getSuppressedOrShelved(): boolean

  • Returns boolean

installInputNodeMonitoring

  • installInputNodeMonitoring(inputNode): void

  • Parameters

    Returns void

isSuppressedOrShelved

  • isSuppressedOrShelved(): boolean

  • Returns boolean

on

  • on(eventName, eventHandler): this

  • Parameters

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

        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

  • on(eventName, eventHandler): this

  • Parameters

    Returns this

raiseConditionEvent

  • raiseConditionEvent(branch, renewEventId): void

  • Parameters

    Returns void

raiseNewBranchState

raiseNewCondition

  • raiseNewCondition(conditionInfo): void

  • Parameters

    Returns void

setEnabledState

  • setEnabledState(requestedEnabledState, options?): StatusCode

  • Parameters

    • requestedEnabledState: boolean
    • Optionaloptions: ISetStateOptions

    Returns StatusCode

setHighHighLimit

  • setHighHighLimit(value): void

  • Parameters

    • value: number

    Returns void

setHighLimit

  • setHighLimit(value): void

  • Parameters

    • value: number

    Returns void

setLocalTime

  • setLocalTime(time): void

  • Parameters

    Returns void

setLowLimit

  • setLowLimit(value): void

  • Parameters

    • value: number

    Returns void

setLowLowLimit

  • setLowLowLimit(value): void

  • Parameters

    • value: number

    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