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

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

#include <fpa.hpp>

Inheritance diagram for fpsdk::common::parser::fpa::FpaAckPayload:
[legend]
Collaboration diagram for fpsdk::common::parser::fpa::FpaAckPayload:
[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

FpaMessageType ack_msg = FpaMessageType::UNSPECIFIED
 Message is being acknowledged.
FpaAckRes ack_res = FpaAckRes::UNSPECIFIED
 Acknowledge result.
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-ACK"
 Message name.

Detailed Description

FP_A-ACK (version 1) message payload.

Definition at line 1142 of file fpa.hpp.

Member Function Documentation

◆ SetFromMsg()

bool fpsdk::common::parser::fpa::FpaAckPayload::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

◆ ack_msg

FpaMessageType fpsdk::common::parser::fpa::FpaAckPayload::ack_msg = FpaMessageType::UNSPECIFIED

Message is being acknowledged.

Definition at line 1144 of file fpa.hpp.

◆ ack_res

FpaAckRes fpsdk::common::parser::fpa::FpaAckPayload::ack_res = FpaAckRes::UNSPECIFIED

Acknowledge result.

Definition at line 1145 of file fpa.hpp.

◆ MSG_NAME

const char* fpsdk::common::parser::fpa::FpaAckPayload::MSG_NAME = "FP_A-ACK"
staticconstexpr

Message name.

Definition at line 1150 of file fpa.hpp.


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