The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    NodeTypeDescription Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:28
    Module: opcua.address_space.types

    Constructor

    NodeTypeDescription

    (
    • options
    )

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:28

    Parameters:

    • options Object
      • [typeDefinitionNode] ExpandedNodeId optional

        NodeId of the originating TypeDefinitionNode of the instances for which data is to be returned.

      • [includeSubtypes] Boolean optional

        A flag that indicates whether the Server should include instances of subtypes of the TypeDefinitionNode in the list of instances of the Node type.

      • [dataToReturn] QueryDataDescription[] optional

        Specifies an Attribute or Reference from the originating typeDefinitionNode along a given relativePath for which to return data. This structure is defined in-line with the following indented items.

    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:

    decode

    (
    • stream
    • [option]
    )

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:98

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:85

    encode the object into a binary stream

    Parameters:

    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:

    Properties

    dataToReturn

    QueryDataDescription[]

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:63

    Specifies an Attribute or Reference from the originating typeDefinitionNode along a given relativePath for which to return data. This structure is defined in-line with the following indented items.

    includeSubtypes

    Boolean

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:56

    A flag that indicates whether the Server should include instances of subtypes of the TypeDefinitionNode in the list of instances of the Node type.

    typeDefinitionNode

    ExpandedNodeId

    Defined in packages\node-opcua-service-query\_generated_\_auto_generated_NodeTypeDescription.js:49

    NodeId of the originating TypeDefinitionNode of the instances for which data is to be returned.