Table of Contents

LengthType element

Specifies whether the parameter has a fixed length.

Type

EnumParamInterpretLengthType

Parent

Interprete

Attributes

Name Type Required Description
id TypeParamId Specifies the ID of another parameter that contains the parameter length.
times unsignedInt Specifies the number of times the next parameter should occur before it is considered to be the next parameter.

Remarks

Contains one of the following values:

fixed

The parameter has a fixed length, which has to be defined in the Protocol.Params.Param.Interprete.Length tag. During parameter initialization, DataMiner does the following for parameters that have LengthType set to "fixed":

  1. A byte array is created with size equal to the value specified in InterPrete.Length. This array is then initialized. The initialization value depends on the RawType value:

    • If RawType is set to "text" or "other", the array is initialized with 0x20 bytes.
    • If RawType is set to "numeric text", the array is initialized with 0x30 bytes.
    • If RawType is set to "signed number", "unsigned number", "double" or "bcd", the array is initialized with 0x00 bytes.

  2. If the parameter specifies a fixed value (Interprete/Value), the byte array is set to the specified value.

For example, executing a GetData (SLProtocol) on a parameter with the following Interprete defined will result in a byte array being returned of size 2, with each byte having a value of 0x20 ([0x20 0x20]).

<Interprete>
    <RawType>other</RawType>
    <Type>string</Type>
    <LengthType>fixed</LengthType>
    <Length>2</Length>
</Interprete>
Note

As a result, the IsEmpty (SLProtocol) method will always return false for fixed length parameters, even if these do not have a value specified (Interprete.Value).

last next param

The parameter has a variable length, which depends on the last instance of the next (fixed-length) parameter in the response.

If the expected response will contain a number with a length up to 5 digits (which can have a decimal point), followed by a fixed point, then you can define two parameters:

  • A first one with a LengthType equal to “last next param” to catch the number containing the decimal point (“last next param” will make sure the number is not broken off at the first point), and
  • A second one with a LengthType equal to “fixed” to catch the point.

next param

The parameter has a variable length, which depends on the next (fixed-length) parameter in the response.

If the expected response will contain a number with a length up to 5 digits, followed by a point, you can define two parameters:

  • A first one with a LengthType equal to “next param” to catch the number, and
  • A second one with a LengthType equal to “fixed” to catch the point.

other param

The length of the parameter will be inherited from another parameter.

The ID of that other parameter has to be specified in the id attribute. See id.

Propose changes