The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    UAAcknowledgeableConditionBase Class

    Extends UAConditionBase
    Defined in: packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:93
    Module: opcua.address_space.AlarmsAndConditions

    Constructor

    Methods

    (static)UAAcknowledgeableConditionBase.instantiate

    (
    • addressSpace
    • conditionTypeId
    • options
    • data
    )
    UAAcknowledgeableConditionBase

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:318

    Parameters:

    Returns:

    UAAcknowledgeableConditionBase:

    _confirm_branch

    (
    • eventId
    • comment
    • branch
    • message
    )
    private

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:223

    Parameters:

    • eventId Object
    • comment Object
    • branch Object
    • message Object

    _setEnabledState

    (
    • requestedEnabledState
    )
    StatusCode private

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:926

    Parameters:

    • requestedEnabledState Boolean

    Returns:

    StatusCode: StatusCodes.Good if successful or BadConditionAlreadyEnabled/BadConditionAlreadyDisabled

    acknowledgeAndAutoConfirmBranch

    (
    • branch
    • comment
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:278

    Parameters:

    • branch Object
    • comment Object

    autoConfirmBranch

    (
    • branch
    • comment
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:260

    Parameters:

    • branch Object
    • comment Object

    getBranchCount

    () Number

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:813

    Returns:

    Number:

    getEnabledState

    () Boolean

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:904

    Returns:

    Boolean:

    getEnabledStateAsString

    () String

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:912

    Returns:

    String:

    post_initialize

    () private

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:790

    raiseConditionEvent Raise a Instance Event (see also UAObject#raiseEvent to raise a transient event)

    (
    • branch
    )

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:1079

    Parameters:

    setLocalTime

    (
    • time
    )

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:1023

    Parameters:

    • time Date

    setReceiveTime

    (
    • time
    )

    Inherited from UAConditionBase: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:1014

    Parameters:

    • time Date

    Events

    acknowledged

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:197

    Event Payload:

    confirmed

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\acknowledgeable_condition.js:249

    Event Payload:

    • eventId Object
    • comment Object
    • eventId raised Object

      when the alarm branch has been confirmed