Enum ParameterType

Enum Documentation

enum class foxglove::ParameterType : uint8_t

An optional type hint for a Parameter, used to disambiguate values whose intended type cannot be inferred from the wire representation alone.

A parameter’s type is typically derived directly from its value: integers, booleans, strings, dicts, and homogeneous arrays of these are unambiguous on the wire. This enum only enumerates the cases that need an explicit hint:

  • ByteArray: a byte array is transmitted as a base64-encoded string, so without a type hint it would be indistinguishable from an ordinary string.

  • Float64: a whole-valued float (e.g. 1.0) may be indistinguishable from an integer on the wire; the hint preserves the intended floating-point type.

  • Float64Array: same rationale as Float64, for arrays.

Parameters of other types (integer, bool, string, dict, arrays of these) leave type() as ParameterType::None.

Values:

enumerator None

The parameter value can be inferred from the inner parameter value tag. Use this for parameters whose type is unambiguous on the wire (integer, bool, string, dict, or homogeneous arrays of these).

enumerator ByteArray

A byte array, transmitted on the wire as a base64-encoded string. The type hint distinguishes it from an ordinary string value.

enumerator Float64

A floating-point value that can be represented as a float64. Used to preserve the floating-point type for whole-valued numbers that would otherwise round-trip as integers.

enumerator Float64Array

An array of floating-point values that can be represented as float64s. Used to preserve the floating-point type for arrays of whole-valued numbers.