The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    EnumValueType Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-data-model\_generated_\_auto_generated_EnumValueType.js:28
    Module: opcua.address_space.types

    Constructor

    EnumValueType

    (
    • options
    )

    Defined in packages\node-opcua-data-model\_generated_\_auto_generated_EnumValueType.js:28

    Parameters:

    • options Object
      • [value] Int64 optional

        The Integer representation of an Enumeration.

      • [displayName] LocalizedText optional

        A human-readable representation of the Value of the Enumeration.

      • [description] LocalizedText optional

        A localized description of the enumeration value. This field can contain an empty string if no description is available

    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-data-model\_generated_\_auto_generated_EnumValueType.js:92

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-data-model\_generated_\_auto_generated_EnumValueType.js:79

    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

    description

    LocalizedText

    Defined in packages\node-opcua-data-model\_generated_\_auto_generated_EnumValueType.js:63

    A localized description of the enumeration value. This field can contain an empty string if no description is available

    displayName

    LocalizedText

    Defined in packages\node-opcua-data-model\_generated_\_auto_generated_EnumValueType.js:56

    A human-readable representation of the Value of the Enumeration.

    value

    Int64

    Defined in packages\node-opcua-data-model\_generated_\_auto_generated_EnumValueType.js:49

    The Integer representation of an Enumeration.