# Copyright (C) 2015-2021 Swift Navigation Inc.
# Contact: https://support.swiftnav.com
#
# This source is subject to the license found in the file 'LICENSE' which must
# be distributed together with this source. All other rights reserved.
#
# THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
# EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

package: swiftnav.sbp.types
description: >
  Documents a variety of common types referenced by the SBP
  specification. Sizes are in bytes.
render_source: false
stable: True
public: True
definitions:
 - s8:
    type: primitive
    desc: Signed 8-bit integer
    size: 1
 - s16:
    type: primitive
    desc: Signed 16-bit integer
    size: 2
 - s32:
    type: primitive
    desc: Signed 32-bit integer
    size: 4
 - s64:
    type: primitive
    desc: Signed 64-bit integer
    size: 8
 - u8:
    type: primitive
    desc: Unsigned 8-bit integer
    size: 1
 - u16:
    type: primitive
    desc: Unsigned 16-bit integer
    size: 2
 - u32:
    type: primitive
    desc: Unsigned 32-bit integer
    size: 4
 - u64:
    type: primitive
    desc: Unsigned 64-bit integer
    size: 8
 - float:
    type: primitive
    desc: Single-precision float (IEEE-754)
    size: 4
 - double:
    type: primitive
    desc: Double-precision float (IEEE-754)
    size: 8
 - array:
    type: collection
    desc: >
      Fixed or variable length array of any fill type
 - string:
    type: collection
    desc: >
      Fixed or variable length string (NULL padded/terminated)
 - bitfield:
    type: collection
    desc: >
      A primitive type, typically a u8, can encode boolean and
      enumerated status flags.