redux::canand::CanandFirmwareVersion Struct Reference

#include <CanandFirmwareVersion.h>

Public Member Functions
constexpr	CanandFirmwareVersion (uint16_t year, uint8_t minor, uint8_t patch)
constexpr uint64_t	ToSettingData ()

Static Public Member Functions
static constexpr CanandFirmwareVersion	FromSettingData (uint64_t value)

Public Attributes
uint16_t	year
uint8_t	minor
uint8_t	patch

Detailed Description

Represents a firmware version associated with a Redux product.

Parameters

year	the year associated with the firmware version. Within a year/season, the message API is expected to remain the same until the postseason.
minor	the minor number associated with the firmware version
patch	the patch number associated with the firmware version

Constructor & Destructor Documentation

CanandFirmwareVersion()

constexpr redux::canand::CanandFirmwareVersion::CanandFirmwareVersion ( uint16_t  year, uint8_t  minor, uint8_t  patch  )

inlineconstexpr

Constructor.

Parameters

year	the year associated with the firmware version. Within a year/season, the message API is expected to remain the same until the postseason.
minor	the minor number associated with the firmware version
patch	the patch number associated with the firmware version

Member Function Documentation

FromSettingData()

static constexpr CanandFirmwareVersion redux::canand::CanandFirmwareVersion::FromSettingData ( uint64_t  value )

inlinestaticconstexpr

Returns a new CanandFirmwareVersion generated from setting data.

Parameters

value

setting data, as a 48-bit long

Returns

CanandFirmwareVersion data

ToSettingData()

constexpr uint64_t redux::canand::CanandFirmwareVersion::ToSettingData ( )

inlineconstexpr

Serializes the firmware version record into a wire-formattable Long.

Returns

long representing the setting data.

Member Data Documentation

minor

uint8_t redux::canand::CanandFirmwareVersion::minor

Firmware minor version.

patch

uint8_t redux::canand::CanandFirmwareVersion::patch

Firmware patch version.

year

uint16_t redux::canand::CanandFirmwareVersion::year

Firmware year.

---

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

• src/main/native/include/redux/canand/CanandFirmwareVersion.h