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

FP_A-TP (versions 1 and 2) message payload. More...

#include <fpa.hpp>

Inheritance diagram for fpsdk::common::parser::fpa::FpaTpPayload:
Collaboration diagram for fpsdk::common::parser::fpa::FpaTpPayload:

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

char tp_name [10] = { 0 }
 Timepulse name (nul-terminated string)
 
FpaTimebase timebase = FpaTimebase::UNSPECIFIED
 Time base.
 
FpaTimeref timeref = FpaTimeref::UNSPECIFIED
 Time reference.
 
FpaInt tp_week
 Timepulse week number (only since version 2 of the message)
 
FpaInt tp_tow_sec
 Timepulse time seconds of week, integer second part (0–604799)
 
FpaFloat tp_tow_psec
 Timepulse time seconds of week, sub-second part (0.000000000000–0.999999999999)
 
FpaInt gps_leaps
 GPS leapseconds.
 
- 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-TP"
 Message name.
 

Detailed Description

FP_A-TP (versions 1 and 2) message payload.

Definition at line 892 of file fpa.hpp.

Member Function Documentation

◆ SetFromMsg()

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

Set data from message.

Parameters
[in]msgPointer to the FP_A message
[in]msg_sizeSize 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

◆ tp_name

char fpsdk::common::parser::fpa::FpaTpPayload::tp_name[10] = { 0 }

Timepulse name (nul-terminated string)

Definition at line 894 of file fpa.hpp.

◆ timebase

FpaTimebase fpsdk::common::parser::fpa::FpaTpPayload::timebase = FpaTimebase::UNSPECIFIED

Time base.

Definition at line 895 of file fpa.hpp.

◆ timeref

FpaTimeref fpsdk::common::parser::fpa::FpaTpPayload::timeref = FpaTimeref::UNSPECIFIED

Time reference.

Definition at line 896 of file fpa.hpp.

◆ tp_week

FpaInt fpsdk::common::parser::fpa::FpaTpPayload::tp_week

Timepulse week number (only since version 2 of the message)

Definition at line 897 of file fpa.hpp.

◆ tp_tow_sec

FpaInt fpsdk::common::parser::fpa::FpaTpPayload::tp_tow_sec

Timepulse time seconds of week, integer second part (0–604799)

Definition at line 898 of file fpa.hpp.

◆ tp_tow_psec

FpaFloat fpsdk::common::parser::fpa::FpaTpPayload::tp_tow_psec

Timepulse time seconds of week, sub-second part (0.000000000000–0.999999999999)

Definition at line 899 of file fpa.hpp.

◆ gps_leaps

FpaInt fpsdk::common::parser::fpa::FpaTpPayload::gps_leaps

GPS leapseconds.

Definition at line 900 of file fpa.hpp.

◆ MSG_NAME

const char* fpsdk::common::parser::fpa::FpaTpPayload::MSG_NAME = "FP_A-TP"
staticconstexpr

Message name.

Definition at line 914 of file fpa.hpp.


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