imu_advanced_navigation_anpp
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
imu_advanced_navigation_anpp::protocol::Acknowledge Struct Reference

#include <Protocol.hpp>

Public Member Functions

bool isMatching (Header const &header) const
 
bool isSuccess () const
 
bool isPacketValidationFailure () const
 
bool isProtocolError () const
 
bool isSystemError () const
 
bool isNotReady () const
 

Static Public Member Functions

template<typename RandomInputIterator >
static Acknowledge unmarshal (RandomInputIterator begin, RandomInputIterator end)
 

Public Attributes

uint8_t acked_packet_id
 
uint8_t acked_payload_checksum_lsb
 
uint8_t acked_payload_checksum_msb
 
uint8_t result
 

Static Public Attributes

static constexpr uint8_t ID = 0
 
static constexpr int SIZE = 4
 

Detailed Description

Acknowledgment packet

Member Function Documentation

◆ isMatching()

bool Acknowledge::isMatching ( Header const &  header) const

Tests whether this acknowledgment matches the given packet header

◆ isNotReady()

bool Acknowledge::isNotReady ( ) const

True if this ack indicates that the system is not ready

◆ isPacketValidationFailure()

bool Acknowledge::isPacketValidationFailure ( ) const

True if this acknowledge is a failure-to-validate-packet error

◆ isProtocolError()

bool Acknowledge::isProtocolError ( ) const

True if this acknowledge indicates a protocol error on the driver side

Packet validation failures are not reported as they might be a communication error as well. Check against sent packets with isMatching to make the difference

◆ isSuccess()

bool Acknowledge::isSuccess ( ) const

True if this indicates a success

◆ isSystemError()

bool Acknowledge::isSystemError ( ) const

True if this acknowledge indicates a system error on the IMU side

◆ unmarshal()

template<typename RandomInputIterator >
static Acknowledge imu_advanced_navigation_anpp::protocol::Acknowledge::unmarshal ( RandomInputIterator  begin,
RandomInputIterator  end 
)
inlinestatic

Initializes an Acknowledge from raw data

Member Data Documentation

◆ acked_packet_id

uint8_t imu_advanced_navigation_anpp::protocol::Acknowledge::acked_packet_id

◆ acked_payload_checksum_lsb

uint8_t imu_advanced_navigation_anpp::protocol::Acknowledge::acked_payload_checksum_lsb

◆ acked_payload_checksum_msb

uint8_t imu_advanced_navigation_anpp::protocol::Acknowledge::acked_payload_checksum_msb

◆ ID

uint8_t const protocol::Acknowledge::ID = 0
static

◆ result

uint8_t imu_advanced_navigation_anpp::protocol::Acknowledge::result

◆ SIZE

constexpr int imu_advanced_navigation_anpp::protocol::Acknowledge::SIZE = 4
static

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