point_one::fusion_engine::messages::DataVersion Struct Reference

Detailed Description

A struct representing the version of a data object.

The version is considered invalid if major_version is 0xFF and minor_version is 0xFFFF.

Definition at line 24 of file data_version.h.

#include <point_one/fusion_engine/messages/data_version.h>

Public Member Functions

constexpr DataVersion ()=default
 
constexpr DataVersion (uint8_t major, uint16_t minor)
 
bool IsValid () const
 Returns whether the stored version is valid. More...
 

Public Attributes

uint8_t major_version = 0xFF
 
uint16_t minor_version = 0xFFFF
 

Constructor & Destructor Documentation

◆ DataVersion() [1/2]

constexpr point_one::fusion_engine::messages::DataVersion::DataVersion ( )
constexprdefault

◆ DataVersion() [2/2]

constexpr point_one::fusion_engine::messages::DataVersion::DataVersion ( uint8_t  major,
uint16_t  minor 
)
inlineconstexpr

Definition at line 31 of file data_version.h.

Member Function Documentation

◆ IsValid()

bool point_one::fusion_engine::messages::DataVersion::IsValid ( ) const
inline

Returns whether the stored version is valid.

Returns
true if the version is valid, false otherwise.

Definition at line 39 of file data_version.h.

Member Data Documentation

◆ major_version

uint8_t point_one::fusion_engine::messages::DataVersion::major_version = 0xFF

Definition at line 27 of file data_version.h.

◆ minor_version

uint16_t point_one::fusion_engine::messages::DataVersion::minor_version = 0xFFFF

Definition at line 28 of file data_version.h.


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