The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.4.5

    • APIs

    Show:

    ConditionInfo Class

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

    Constructor

    ConditionInfo

    (
    • options
    )

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

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

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

    Parameters:

    • node BaseNode
    • key String

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

    Parameters:

    instantiate

    (
    • namespace
    • conditionTypeId
    • options
    • data
    )
    UAConditionBase

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

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

    Parameters:

    • namespace Namespace
    • 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:1144

    Parameters:

    Returns:

    Boolean:

    raiseNewCondition

    (
    • conditionInfo
    )

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

    Parameters:

    with_condition_method$

    (
    • inputArguments
    • context
    • callback
    • inner_func
    )
    Void

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

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

    Parameters:

    Returns:

    Void:

    Properties

    conditionName

    UAVariable

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

    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.

    conditionName

    UAVariable

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

    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

    Events

    addComment

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

    raised when the branch has been added a comment

    Event Payload: