comms::option::def::FixedLength< TLen, TSignExtend > Struct Template Reference

#include "comms/options.h"

Detailed Description

template<std::size_t TLen, bool TSignExtend = true>
struct comms::option::def::FixedLength< TLen, TSignExtend >

Option used to specify number of bytes that is used for field serialisation.

Applicable only to numeric fields, such as comms::field::IntValue or comms::field::EnumValue.

For example, protocol specifies that some field is serialised using only 3 bytes. There is no basic integral type that takes 3 bytes of space exactly. The closest alternative is std::int32_t or std::uint32_t. Such field may be defined as:

using MyFieldBase = comms::Field<comms::option::def::BigEndian>;
using MyField =
    comms::field::IntValue<
        MyFieldBase,
        std::uint32_t,
        comms::option::def::FixedLength<3>
    >;

Template Parameters

TLen	Length of the serialised value.
TSignExtend	Perform sign extension, relevant only to signed types.

---

The documentation for this struct was generated from the following file:

• include/comms/options.h