The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.2.0

    • APIs

    Show:

    ConditionSnapshot Class

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

    Constructor

    ConditionSnapshot

    (
    • condition
    • branchId
    )
    private

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

    Parameters:

    • condition Object
    • branchId Object

    Methods

    getEnabledState

    () Boolean

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

    Returns:

    Boolean:

    getEnabledStateAsString

    () String

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

    Returns:

    String:

    getEventId

    () ByteString

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

    Returns:

    ByteString:

    getLastSeverity

    () UInt16

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

    Returns:

    UInt16:

    getRetain

    () Boolean

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

    Returns:

    Boolean:

    getSeverity

    () UInt16

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

    Returns:

    UInt16:

    getSourceNode!~YUIDOC_LINE~!return

    ()

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

    getSuppressedState

    () Boolean

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

    Returns:

    Boolean:

    readValue

    (
    • nodeId
    • selectClause
    )
    Variant

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

    Parameters:

    • nodeId NodeId
    • selectClause SelectClause

    Returns:

    Variant:

    resolveSelectClause

    (
    • selectClause
    )

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

    Parameters:

    • selectClause SelectClause

    setClientUserId

    (
    • userIdentity
    )

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

    Parameters:

    • userIdentity String

    setComment

    (
    • txtMessage
    )

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

    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:370

    Parameters:

    • value Boolean

    Returns:

    void

    setLastSeverity

    (
    • severity
    )

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

    Parameters:

    • severity UInt16

    setLocalTime

    (
    • localTime
    )

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

    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:423

    Parameters:

    setQuality

    (
    • quality
    )

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

    set the condition quality

    Parameters:

    setReceiveTime

    (
    • time
    )

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

    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:335

    Parameters:

    • retainFlag Boolean

    setSeverity

    (
    • severity
    )

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

    Parameters:

    • severity UInt16

    setSuppressedState

    (
    • suppressed
    )

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

    Parameters:

    • suppressed Boolean

    setTime

    (
    • time
    )

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

    (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