comms::option::def::ScalingRatio< TNum, TDenom > Struct Template Reference

#include "comms/options.h"

Detailed Description

template<std::intmax_t TNum, std::intmax_t TDenom>
struct comms::option::def::ScalingRatio< TNum, TDenom >

Option to specify scaling ratio.

Applicable only to comms::field::IntValue. Sometimes the protocol specifies values being transmitted in one units while when handling the message they are better to be handled in another. For example, some distance information is transmitted as integer value of millimetres, but while processing it should be handled as floating point value of meters. Such field is defined as:

using MyFieldBase = comms::Field<comms::option::def::BigEndian>;
using MyField =
    comms::field::IntValue<
        MyFieldBase,
        std::int32_t,
        comms::option::def::ScalingRatio<1, 100>
    >;

Then, to accessed the scaled value of the field use scaleAs() or setScaled() methods of comms::field::IntValue field:

void processField(const MyField& field)
{
    auto distInMillimetres = field.value();
    auto distInMeters = field.scaleAs<double>();
}

Template Parameters

TNum	Numerator of the scaling ratio.
TDenom	Denominator of the scaling ratio.

---

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

• include/comms/options.h