Variable Variant

Type Declaration

• createAlertTime: function

  • createAlertTime(value: WinccoaAlertTime): Vrpc.Variant

    Creates an alert time variant.

    Parameters

    • value: WinccoaAlertTime

      The alert time value.

    Returns Vrpc.Variant

    The created variant.

• createAlertTimeArray: function

  • createAlertTimeArray(value: WinccoaAlertTime[]): Vrpc.Variant

    Creates an alert time array variant.

    Parameters

    • value: WinccoaAlertTime[]

      The alert time array value.

    Returns Vrpc.Variant

    The created variant.

• createBit32: function

  • createBit32(value: number): Vrpc.Variant

    Creates a 32-bit bitfield variant.

    Parameters

    • value: number

      The 32-bit bitfield value.

    Returns Vrpc.Variant

    The created variant.

• createBit32Array: function

  • createBit32Array(value: number[]): Vrpc.Variant

    Creates a 32-bit bitfield array variant.

    Parameters

    • value: number[]

      The 32-bit bitfield array value.

    Returns Vrpc.Variant

    The created variant.

• createBit64: function

  • createBit64(value: number | bigint): Vrpc.Variant

    Creates a 64-bit bitfield variant.

    Parameters

    • value: number | bigint

      The 64-bit bitfield value.

    Returns Vrpc.Variant

    The created variant.

• createBit64Array: function

  • createBit64Array(value: number[] | bigint[]): Vrpc.Variant

    Creates a 64-bit bitfield array variant.

    Parameters

    • value: number[] | bigint[]

      The 64-bit bitfield array value.

    Returns Vrpc.Variant

    The created variant.

• createBlob: function

  • createBlob(value: Buffer): Vrpc.Variant

    Creates a blob variant.

    Parameters

    • value: Buffer

      The blob value.

    Returns Vrpc.Variant

    The created variant.

• createBlobArray: function

  • createBlobArray(value: Buffer<ArrayBufferLike>[]): Vrpc.Variant

    Creates a blob array variant.

    Parameters

    • value: Buffer<ArrayBufferLike>[]

      The blob array value.

    Returns Vrpc.Variant

    The created variant.

• createBool: function

  • createBool(value: boolean): Vrpc.Variant

    Creates a bool variant.

    Parameters

    • value: boolean

      The boolean value.

    Returns Vrpc.Variant

    The created variant.

• createBoolArray: function

  • createBoolArray(value: boolean[]): Vrpc.Variant

    Creates a boolean array variant.

    Parameters

    • value: boolean[]

      The boolean array value.

    Returns Vrpc.Variant

    The created variant.

• createByte: function

  • createByte(value: number): Vrpc.Variant

    Creates a byte variant.

    Parameters

    • value: number

      The byte value.

    Returns Vrpc.Variant

    The created variant.

• createByteArray: function

  • createByteArray(value: number[]): Vrpc.Variant

    Creates a byte array variant.

    Parameters

    • value: number[]

      The byte array value.

    Returns Vrpc.Variant

    The created variant.

• createDouble: function

  • createDouble(value: number): Vrpc.Variant

    Creates a double variant.

    Parameters

    • value: number

      The double value.

    Returns Vrpc.Variant

    The created variant.

• createDoubleArray: function

  • createDoubleArray(value: number[]): Vrpc.Variant

    Creates a double array variant.

    Parameters

    • value: number[]

      The double array value.

    Returns Vrpc.Variant

    The created variant.

• createDpIdentifier: function

  • createDpIdentifier(value: string): Vrpc.Variant

    Creates a data point identifier variant.

    Parameters

    • value: string

      The data point identifier value.

    Returns Vrpc.Variant

    The created variant.

• createDpIdentifierArray: function

  • createDpIdentifierArray(value: string[]): Vrpc.Variant

    Creates a data point identifier array variant.

    Parameters

    • value: string[]

      The data point identifier array value.

    Returns Vrpc.Variant

    The created variant.

• createInt: function

  • createInt(value: number): Vrpc.Variant

    Creates an integer variant.

    Parameters

    • value: number

      The integer value.

    Returns Vrpc.Variant

    The created variant.

• createIntArray: function

  • createIntArray(value: number[]): Vrpc.Variant

    Creates an integer array variant.

    Parameters

    • value: number[]

      The integer array value.

    Returns Vrpc.Variant

    The created variant.

• createLangString: function

  • createLangString(
        value: string | object | string[] | Vrpc.LangString,
    ): Vrpc.Variant

    Creates a LangString variant.

    Parameters

    • value: string | object | string[] | Vrpc.LangString

      The LangString value.

    Returns Vrpc.Variant

    The created variant.

• createLangStringArray: function

  • createLangStringArray(
        value: string[] | Vrpc.LangString[] | string[][] | object[],
    ): Vrpc.Variant

    Creates a LangString array variant.

    Parameters

    • value: string[] | Vrpc.LangString[] | string[][] | object[]

      The LangString array value.

    Returns Vrpc.Variant

    The created variant.

• createLong: function

  • createLong(value: number | bigint): Vrpc.Variant

    Creates a long variant.

    Parameters

    • value: number | bigint

      The long value.

    Returns Vrpc.Variant

    The created variant.

• createLongArray: function

  • createLongArray(value: number[] | bigint[]): Vrpc.Variant

    Creates a long array variant.

    Parameters

    • value: number[] | bigint[]

      The long array value.

    Returns Vrpc.Variant

    The created variant.

• createMapping: function

  • createMapping(value: Vrpc.Mapping): Vrpc.Variant

    Creates a mapping variant.

    Parameters

    • value: Vrpc.Mapping

      The mapping value.

    Returns Vrpc.Variant

    The created variant.

• createMappingArray: function

  • createMappingArray(value: Vrpc.Mapping[]): Vrpc.Variant

    Creates a mapping array variant.

    Parameters

    • value: Vrpc.Mapping[]

      The mapping array value.

    Returns Vrpc.Variant

    The created variant.

• createString: function

  • createString(value: string): Vrpc.Variant

    Creates a string variant.

    Parameters

    • value: string

      The string value.

    Returns Vrpc.Variant

    The created variant.

• createStringArray: function

  • createStringArray(value: string[]): Vrpc.Variant

    Creates a string array variant.

    Parameters

    • value: string[]

      The string array value.

    Returns Vrpc.Variant

    The created variant.

• createTime: function

  • createTime(value: WinccoaTime): Vrpc.Variant

    Creates a time variant.

    Parameters

    • value: WinccoaTime

      The time value.

    Returns Vrpc.Variant

    The created variant.

• createTimeArray: function

  • createTimeArray(value: WinccoaTime[]): Vrpc.Variant

    Creates a time array variant.

    Parameters

    • value: WinccoaTime[]

      The time array value.

    Returns Vrpc.Variant

    The created variant.

• createUInt: function

  • createUInt(value: number): Vrpc.Variant

    Creates an unsigned integer variant.

    Parameters

    • value: number

      The unsigned integer value.

    Returns Vrpc.Variant

    The created variant.

• createUIntArray: function

  • createUIntArray(value: number[]): Vrpc.Variant

    Creates an unsigned integer array variant.

    Parameters

    • value: number[]

      The unsigned integer array value.

    Returns Vrpc.Variant

    The created variant.

• createULong: function

  • createULong(value: number | bigint): Vrpc.Variant

    Creates an unsigned long variant.

    Parameters

    • value: number | bigint

      The unsigned long value.

    Returns Vrpc.Variant

    The created variant.

• createULongArray: function

  • createULongArray(value: number[] | bigint[]): Vrpc.Variant

    Creates an unsigned long array variant.

    Parameters

    • value: number[] | bigint[]

      The unsigned long array value.

    Returns Vrpc.Variant

    The created variant.

• createUndefined: function

  • createUndefined(): Vrpc.Variant

    Creates an undefined variant.

    Returns Vrpc.Variant

    The created variant.