The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    SimpleAttributeOperand Class

    Extends FilterOperand
    Defined in: packages\node-opcua-service-filter\src\tools_event_filter.js:165
    Module: service.filter.tools

    Constructor

    SimpleAttributeOperand

    (
    • options
    )
    String

    Defined in packages\node-opcua-service-filter\src\tools_event_filter.js:165

    Parameters:

    • options Object
      • [typeId] NodeId optional

        NodeId of a TypeDefinitionNode.

      • [browsePath] QualifiedName[] optional
      • [attributeId] IntegerId optional
      • [indexRange] NumericRange optional

    Returns:

    String:

    Example:

    :

    Methods

    binaryStoreSize

    () Number

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:49

    Calculate the required size to store this object in a binary stream.

    Returns:

    Number:

    constructEventFilter

    (
    • arrayOfNames
    • conditionTypes
    )
    EventFilter

    Defined in packages\node-opcua-service-filter\src\tools_event_filter.js:29

    helper to construct event filters: construct a simple event filter

    Parameters:

    • arrayOfNames Array
    • conditionTypes Array

    Returns:

    EventFilter:

    Example:

    constructEventFilter(["SourceName","Message","ReceiveTime"]);
                    
                    constructEventFilter(["SourceName",{namespaceIndex:2 , "MyData"}]);
                    constructEventFilter(["SourceName","2:MyData" ]);
                    
                    constructEventFilter(["SourceName" ,["EnabledState","EffectiveDisplayName"] ]);
                    constructEventFilter(["SourceName" ,"EnabledState.EffectiveDisplayName" ]);

    decode

    (
    • stream
    • [option]
    )

    Inherited from FilterOperand but overwritten in packages\node-opcua-service-filter\_generated_\_auto_generated_SimpleAttributeOperand.js:110

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Inherited from FilterOperand but overwritten in packages\node-opcua-service-filter\_generated_\_auto_generated_SimpleAttributeOperand.js:96

    encode the object into a binary stream

    Parameters:

    extractEventField extract a eventField from a event node, matching the given selectClause

    (
    • eventData
    • selectClause
    )

    Defined in packages\node-opcua-service-filter\src\tools_event_filter.js:195

    Parameters:

    • eventData Object
    • selectClause Object

    extractEventFields extract a array of eventFields from a event node, matching the selectClauses

    (
    • selectClauses
    • eventData
    )

    Defined in packages\node-opcua-service-filter\src\tools_event_filter.js:259

    Parameters:

    • selectClauses Object
    • eventData Object

      : a pseudo Node that provides a browse Method and a readValue(nodeId)

    isValid

    () Boolean

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:83

    verify that all object attributes values are valid according to schema

    Returns:

    Boolean:

    toString

    () String

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

    Returns:

    String: