pamoja for TypeScript - v0.1.17
    Preparing search index...

    Class MessageSchemaBuilder

    Describes a message this build does not type, one field at a time.

    Fields are added in the order the message definition lists them; building puts them in wire order and derives the CRC_EXTRA seed from the result.

    Index
    • Starts describing a message.

      Parameters

      • msgid: number

        The message id on the wire.

      • name: string

        The message name, which the seed derivation folds in, so it must match the dialect exactly.

      Returns MessageSchemaBuilder

    • Puts the declared fields in wire order and finishes the shape.

      Returns MessageSchema

      The finished schema.

      If two fields share a name, the fields do not fit a MAVLink payload, or the shape is already built.

    • Adds a MAVLink 2 extension field, in the order the definition declares it.

      Extensions keep their declared order, stay out of the CRC_EXTRA seed, and read as zero from a frame sent by a peer that predates them.

      Parameters

      • name: string

        The field name.

      • fieldType: number

        The field's type, one of the MAVLINK_FIELD_* codes.

      • OptionalarrayLen: number | null

        The element count for an array, or 0 for a scalar.

      Returns void

      If the type is not a MAVLink field type, or the shape is already built.

    • Adds a base field, in the order the definition declares it.

      Parameters

      • name: string

        The field name.

      • fieldType: number

        The field's type, one of the MAVLINK_FIELD_* codes.

      • OptionalarrayLen: number | null

        The element count for an array, or 0 for a scalar.

      Returns void

      If the type is not a MAVLink field type, or the shape is already built.