The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    AxisInformation Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:30
    Module: opcua.address_space.types

    Constructor

    AxisInformation

    (
    • options
    )

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:30

    Parameters:

    • options Object
      • [engineeringUnits] EUInformation optional

        Holds the information about the engineering units for a given axis.

      • [euRange] Range optional

        Limits of the range of the axis

      • [title] LocalizedText optional

        User readable axis title, useful when the units are %, the Title may be Particle size

      • [axisScaleType] AxisScaleEnumeration optional

        LINEAR, LOG, LN, defined by AxisSteps

      • [axisSteps= null] Double optional

        Specific value of each axis steps, may be set to Null if not used

    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:

    createExtensionObjectDefinition

    (
    • addressSpace
    )

    Provided by the opcua.miscellaneous module.

    Defined in packages\node-opcua-convert-nodeset-to-javascript\src\convert_nodeset_to_types.js:379

    creates the requested data structure and javascript objects for the OPCUA objects

    Parameters:

    decode

    (
    • stream
    • [option]
    )

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:125

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:110

    encode the object into a binary stream

    Parameters:

    generateEnumerationCode

    (
    • dataType
    • filename
    )

    Provided by the opcua.miscellaneous module.

    Defined in packages\node-opcua-convert-nodeset-to-javascript\src\convert_nodeset_to_types.js:64

    convert a nodeset enumeration into a javascript script enumeration code

    Parameters:

    • dataType Object
    • filename String

      the output filename

    getSchemaSourceFile

    (
    • namespace
    • schemaName
    • schema_type
    • schema_folder
    )
    String private

    Provided by the opcua.miscellaneous module.

    Defined in packages\node-opcua-convert-nodeset-to-javascript\src\convert_nodeset_to_types.js:30

    returns the location of the javascript version of the schema corresponding to schemaName

    Parameters:

    • namespace String
    • schemaName String
    • schema_type String

      "enum" | "schema"

    • schema_folder String

    Returns:

    String:

    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:

    makeEnumeration

    (
    • dataType
    )

    Provided by the opcua.miscellaneous module.

    Defined in packages\node-opcua-convert-nodeset-to-javascript\src\convert_nodeset_to_types.js:102

    var dataType = { browseName: "Color", definition: [ { name: "Red", value: 12}, { name: "Blue", value: 11} ] };

    makeEnumeration(dataType);

    Parameters:

    • dataType Object

    Returns:

    :

    toString

    () String

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

    Returns:

    String:

    Properties

    axisScaleType

    AxisScaleEnumeration

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:74

    LINEAR, LOG, LN, defined by AxisSteps

    axisSteps

    Double

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:81

    Specific value of each axis steps, may be set to Null if not used

    Default: null

    engineeringUnits

    EUInformation

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:53

    Holds the information about the engineering units for a given axis.

    title

    LocalizedText

    Defined in packages\node-opcua-data-access\_generated_\_auto_generated_AxisInformation.js:67

    User readable axis title, useful when the units are %, the Title may be Particle size