fpsdk::common::parser::fpa::FpaTextPayload Struct Reference

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

#include <fpa.hpp>

Inheritance diagram for fpsdk::common::parser::fpa::FpaTextPayload:

Collaboration diagram for fpsdk::common::parser::fpa::FpaTextPayload:

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

Public Attributes
FpaTextLevel	level
	Level.
char	text [MAX_FP_A_SIZE] = { 0 }
	Text (nul-terminated string)
Public Attributes inherited from fpsdk::common::parser::fpa::FpaPayload
bool	valid_ = false
	Payload successfully decoded (true), or not (yet) decoded (false)

Static Public Attributes
static constexpr const char *	MSG_NAME = "FP_A-TEXT"
	Message name.

Detailed Description

FP_A-TEXT (version 1) message payload.

Definition at line 843 of file fpa.hpp.

Member Function Documentation

SetFromMsg()

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

Set data from message.

Parameters

[in]	msg	Pointer to the FP_A message
[in]	msg_size	Size of the FP_A message (>= 11)

Returns

true if sentence payload was correct and all data could be extracted (fields are now valid), or false otherwise (fields are now invalid)

Member Data Documentation

level

FpaTextLevel fpsdk::common::parser::fpa::FpaTextPayload::level

Level.

Definition at line 845 of file fpa.hpp.

text

char fpsdk::common::parser::fpa::FpaTextPayload::text[MAX_FP_A_SIZE] = { 0 }

Text (nul-terminated string)

Definition at line 846 of file fpa.hpp.

MSG_NAME

const char* fpsdk::common::parser::fpa::FpaTextPayload::MSG_NAME = "FP_A-TEXT"

staticconstexpr

Message name.

Definition at line 860 of file fpa.hpp.

---

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

• fpsdk_common/include/fpsdk_common/parser/fpa.hpp