The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    ConditionInfo Class

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

    Constructor

    ConditionInfo

    (
    • options
    )

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

    Parameters:

    • options Object
      • message String | LocalizedText

        the event message

      • severity UInt16

        severity

      • quality StatusCode

        quality

      • retain Boolean

        retain flag

    Methods

    _check_subscription_id_is_valid

    (
    • subscriptionId
    • context
    )
    private

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

    verify that the subscription id belongs to the session that make the call.

    Parameters:

    • subscriptionId Number
    • context Object

    _getCompositeKey

    (
    • node
    • key
    )
    BaseNode private

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

    Parameters:

    Returns:

    BaseNode:

    Example:

    var node  = _getComposite(node,"enabledState.id");

    _raiseAuditConditionCommentEvent

    (
    • sourceName
    • eventId
    • comment
    )
    private

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

    Parameters:

    instantiate

    (
    • addressSpace
    • conditionTypeId
    • options
    • data
    )
    UAConditionBase

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

    instantiate a Condition. this will create the unique EventId and will set eventType

    Parameters:

    • addressSpace Object
    • conditionTypeId String | NodeId

      the EventType to instantiate

    • options Object
      • browseName String | QualifiedName
      • componentOf NodeId | UAObject
      • conditionOf NodeId | UAObject

        Mandatory

      • organizedBy NodeId | UAObject

        ( only provide componentOf or organizedBy but not both)

      • [conditionClass=BaseConditionClassType] NodeId | UAObject optional 
                                    The condition Class nodeId or object used to set the ConditionClassId and
                                                ConditionClassName properties of the condition.
      • conditionSource NodeId | UAObject

        the condition source node. this node must be marked a EventSource. the conditionSource is used to populate the sourceNode and sourceName variables defined by BaseEventType

      • conditionName String

        the condition Name

      • [optionals] [Array<String>] optional

        an Array of optinals fields

    • data Object

      a object containing the value to set

      • eventId String | NodeId

        the EventType Identifier to instantiate (type cannot be abstract)

    Returns:

    UAConditionBase:

    node

    isDifferentFrom

    (
    • otherConditionInfo
    )
    Boolean

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

    Parameters:

    Returns:

    Boolean:

    raiseNewCondition

    (
    • conditionInfo
    )

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

    Parameters:

    with_condition_method$

    (
    • inputArguments
    • context
    • callback
    • inner_func
    )
    Void

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

    Helper method to handle condition methods that takes a branchId and a comment

    Parameters:

    Returns:

    Void:

    Properties

    branchId

    UAVariableType dataType is DataType.NodeId

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

    comment

    UAVariableType dataType is DataType.LocalizedText

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

    conditionName

    UAVariable dataType: DataType.String As per spec OPCUA 1.03 part 9: ConditionName identifies the Condition instance that the Event originated from. It can be used together with the SourceName in a user display to distinguish between different Condition instances. If a ConditionSource has only one instance of a ConditionType, and the Server has no instance name, the Server shall supply the ConditionType browse name.

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

    conditionName

    UAVariable dataType: DataType.NodeId As per spec OPCUA 1.03 part 9: ConditionClassId specifies in which domain this Condition is used. It is the NodeId of the corresponding ConditionClassType. See 5.9 for the definition of ConditionClass and a set of ConditionClasses defined in this standard. When using this Property for filtering, Clients have to specify all individual ConditionClassType NodeIds. The OfType operator cannot be applied. BaseConditionClassType is used as class whenever a Condition cannot be assigned to a more concrete class. BaseConditionClassType | +---------------------------+----------------------------+ | | | ProcessConditionClassType MaintenanceConditionClassType SystemConditionClassType

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

    eventType

    UAVariableType dataType is DataType.NodeId

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

    lastSeverity

    UAVariableType dataType is DataType.StatusCode

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

    quality

    UAVariableType dataType is DataType.StatusCode

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

    sourceNode

    UAVariableType dataType is DataType.NodeId

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

    Events

    addComment

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

    Event Payload: