Fixposition SDK 0.0.0-heads/main-0-g408dc89
Collection of c++ libraries and apps for use with Fixposition products on Linux
Loading...
Searching...
No Matches
fpsdk::common::parser::fpa::FpaVersionPayload Struct Reference

FP_A-VERSION (version 1) message payload. More...

#include <fpa.hpp>

Inheritance diagram for fpsdk::common::parser::fpa::FpaVersionPayload:
[legend]
Collaboration diagram for fpsdk::common::parser::fpa::FpaVersionPayload:
[legend]

Public Member Functions

bool SetFromMsg (const uint8_t *msg, const std::size_t msg_size) final
 Set data from message.
Public Member Functions inherited from fpsdk::common::parser::fpa::FpaPayload
virtual ~FpaPayload ()=default
 Virtual dtor for polymorphism.
bool SetFromBuf (const std::vector< uint8_t > &buf)
 Set data from message.

Public Attributes

char sw_version [100] = { 0 }
 Software version string.
char hw_name [100] = { 0 }
 Hardware name.
char hw_ver [100] = { 0 }
 Hardware version string.
char hw_uid [100] = { 0 }
 Hardware UID.
char product_model [100] = { 0 }
 Product model.
Public Attributes inherited from fpsdk::common::parser::fpa::FpaPayload
bool valid_ = false
 Payload successfully decoded (true), or not (yet) decoded (false)
FpaMessageType msg_type_ = FpaMessageType::UNSPECIFIED
 Message (payload) type.

Static Public Attributes

static constexpr const char * MSG_NAME = "FP_A-VERSION"
 Message name.

Detailed Description

FP_A-VERSION (version 1) message payload.

Definition at line 880 of file fpa.hpp.

Member Function Documentation

◆ SetFromMsg()

bool fpsdk::common::parser::fpa::FpaVersionPayload::SetFromMsg ( const uint8_t * msg,
const std::size_t msg_size )
finalvirtual

Set data from message.

Parameters
[in]msgPointer to the FP_A message
[in]msg_sizeSize of the FP_A message (>= 11)
Returns
true if message payload was correct and all data could be extracted (fields are now valid), or false otherwise (fields are now invalid)

Implements fpsdk::common::parser::fpa::FpaPayload.

Member Data Documentation

◆ sw_version

char fpsdk::common::parser::fpa::FpaVersionPayload::sw_version[100] = { 0 }

Software version string.

Definition at line 882 of file fpa.hpp.

◆ hw_name

char fpsdk::common::parser::fpa::FpaVersionPayload::hw_name[100] = { 0 }

Hardware name.

Definition at line 883 of file fpa.hpp.

◆ hw_ver

char fpsdk::common::parser::fpa::FpaVersionPayload::hw_ver[100] = { 0 }

Hardware version string.

Definition at line 884 of file fpa.hpp.

◆ hw_uid

char fpsdk::common::parser::fpa::FpaVersionPayload::hw_uid[100] = { 0 }

Hardware UID.

Definition at line 885 of file fpa.hpp.

◆ product_model

char fpsdk::common::parser::fpa::FpaVersionPayload::product_model[100] = { 0 }

Product model.

Definition at line 886 of file fpa.hpp.

◆ MSG_NAME

const char* fpsdk::common::parser::fpa::FpaVersionPayload::MSG_NAME = "FP_A-VERSION"
staticconstexpr

Message name.

Definition at line 891 of file fpa.hpp.


The documentation for this struct was generated from the following file:
  • fpsdk_common/include/fpsdk_common/parser/fpa.hpp