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

#include "comms/options.h"

Detailed Description

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

Option used to specify number of bits that is used for field serialisation when a field is a member of comms::field::Bitfield.

For example, the protocol specifies that two independent integer values of 6 and 10 bits respectively packed into two bytes to save space. Such combined field may be defined as:

using MyFieldBase = comms::Field<comms::option::def::BigEndian>;
using MyField =
    comms::field::Bitfield<
        MyFieldBase,
        std::tuple<
            comms::field::IntValue<
                MyFieldBase,
                std::uint8_t,
                comms::option::def::FixedBitLength<6>
            >,
            comms::field::IntValue<
                MyFieldBase,
                std::uint16_t,
                comms::option::def::FixedBitLength<10>
            >
        >
    >;

Template Parameters

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

---

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

• include/comms/options.h