The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    ConditionSnapshot Class

    Extends EventEmitter
    Defined in: packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:670
    Module: opcua.address_space.AlarmsAndConditions

    Constructor

    ConditionSnapshot

    (
    • condition
    • branchId
    )
    private

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:670

    Parameters:

    • condition Object
    • branchId Object

    Methods

    getEnabledState

    () Boolean

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:358

    Returns:

    Boolean:

    getEnabledStateAsString

    () String

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:375

    Returns:

    String:

    getEventId

    () ByteString

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:314

    Returns:

    ByteString:

    getLastSeverity

    () UInt16

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:571

    Returns:

    UInt16:

    getRetain

    () Boolean

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:322

    Returns:

    Boolean:

    getSeverity

    () UInt16

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:544

    Returns:

    UInt16:

    getSourceNode!~YUIDOC_LINE~!return

    ()

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:642

    getSuppressedState

    () Boolean

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:75

    Returns:

    Boolean:

    readValue

    (
    • nodeId
    • selectClause
    )
    Variant

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:213

    Parameters:

    • nodeId NodeId
    • selectClause SelectClause

    Returns:

    Variant:

    resolveSelectClause

    (
    • selectClause
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:204

    Parameters:

    • selectClause SelectClause

    setClientUserId

    (
    • userIdentity
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:431

    Parameters:

    • userIdentity String

    setComment

    (
    • txtMessage
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:393

    Set condition comment

    Comment contains the last comment provided for a certain state (ConditionBranch). It may have been provided by an AddComment Method, some other Method or in some other manner. The initial value of this Variable is null, unless it is provided in some other manner. If a Method provides as an option the ability to set a Comment, then the value of this Variable is reset to null if an optional comment is not provided.

    Parameters:

    setEnabledState

    (
    • value
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:366

    Parameters:

    • value Boolean

    Returns:

    void

    setLastSeverity

    (
    • severity
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:562

    Parameters:

    • severity UInt16

    setLocalTime

    (
    • localTime
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:622

    LocalTime is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset specifies the time difference (in minutes) between the Time Property and the time at the location in which the event was issued. If DaylightSavingInOffset is TRUE, then Standard/Daylight savings time (DST) at the originating location is in effect and Offset includes the DST c orrection. If FALSE then the Offset does not include DST correction and DST may or may not have been in effect.

    Parameters:

    setMessage

    (
    • txtMessage
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:419

    Parameters:

    setQuality

    (
    • quality
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:465

    set the condition quality

    Parameters:

    setReceiveTime

    (
    • time
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:581

    setReceiveTime

    (as per OPCUA 1.0.3 part 5)

    ReceiveTime provides the time the OPC UA Server received the Event from the underlying device of another Server.

    ReceiveTime is analogous to ServerTimestamp defined in Part 4, i.e. in the case where the OPC UA Server gets an Event from another OPC UA Server, each Server applies its own ReceiveTime. That implies that a Client may get the same Event, having the same EventId, from different Servers having different values of the ReceiveTime.

    The ReceiveTime shall always be returned as value and the Server is not allowed to return a StatusCode for the ReceiveTime indicating an error.

    Parameters:

    • time Date

      : UTCTime

    setRetain

    (
    • retainFlag
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:331

    Parameters:

    • retainFlag Boolean

    setSeverity

    (
    • severity
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:523

    Parameters:

    • severity UInt16

    setSuppressedState

    (
    • suppressed
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\alarm_condition.js:84

    Parameters:

    • suppressed Boolean

    setTime

    (
    • time
    )

    Defined in packages\node-opcua-address-space\src\alarms_and_conditions\condition.js:606

    (as per OPCUA 1.0.3 part 5)

    Time provides the time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device. Once set, intermediate OPC UA Servers shall not alter the value.

    Parameters:

    • time Date