Common Enumeration Definitions

Enumerations

enum  point_one::fusion_engine::messages::Response : uint8_t {
  point_one::fusion_engine::messages::Response::OK = 0, point_one::fusion_engine::messages::Response::UNSUPPORTED_CMD_VERSION = 1, point_one::fusion_engine::messages::Response::UNSUPPORTED_FEATURE = 2, point_one::fusion_engine::messages::Response::VALUE_ERROR = 3,
  point_one::fusion_engine::messages::Response::INSUFFICIENT_SPACE = 4, point_one::fusion_engine::messages::Response::EXECUTION_FAILURE = 5, point_one::fusion_engine::messages::Response::INCONSISTENT_PAYLOAD_LENGTH = 6, point_one::fusion_engine::messages::Response::DATA_CORRUPTED = 7
}
 Command response status indicators. More...
 
enum  point_one::fusion_engine::messages::SatelliteType : uint8_t {
  point_one::fusion_engine::messages::SatelliteType::UNKNOWN = 0, point_one::fusion_engine::messages::SatelliteType::GPS = 1, point_one::fusion_engine::messages::SatelliteType::GLONASS = 2, point_one::fusion_engine::messages::SatelliteType::LEO = 3,
  point_one::fusion_engine::messages::SatelliteType::GALILEO = 4, point_one::fusion_engine::messages::SatelliteType::BEIDOU = 5, point_one::fusion_engine::messages::SatelliteType::QZSS = 6, point_one::fusion_engine::messages::SatelliteType::MIXED = 7,
  point_one::fusion_engine::messages::SatelliteType::SBAS = 8, point_one::fusion_engine::messages::SatelliteType::IRNSS = 9, point_one::fusion_engine::messages::SatelliteType::MAX_VALUE = IRNSS
}
 System/constellation type definitions. More...
 
enum  point_one::fusion_engine::messages::SolutionType : uint8_t {
  point_one::fusion_engine::messages::SolutionType::Invalid = 0, point_one::fusion_engine::messages::SolutionType::AutonomousGPS = 1, point_one::fusion_engine::messages::SolutionType::DGPS = 2, point_one::fusion_engine::messages::SolutionType::RTKFixed = 4,
  point_one::fusion_engine::messages::SolutionType::RTKFloat = 5, point_one::fusion_engine::messages::SolutionType::Integrate = 6, point_one::fusion_engine::messages::SolutionType::Visual = 9, point_one::fusion_engine::messages::SolutionType::PPP = 10,
  point_one::fusion_engine::messages::SolutionType::MAX_VALUE = PPP
}
 Navigation solution type definitions. More...
 

Functions

std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, MessageType type)
 MessageType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, Response val)
 Response stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, SatelliteType type)
 SatelliteType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, SolutionType type)
 SolutionType stream operator. More...
 
const char * point_one::fusion_engine::messages::to_string (MessageType type)
 Get a human-friendly string name for the specified MessageType. More...
 
const char * point_one::fusion_engine::messages::to_string (Response val)
 Get a human-friendly string name for the specified Response. More...
 
const char * point_one::fusion_engine::messages::to_string (SatelliteType type)
 Get a human-friendly string name for the specified SatelliteType (GNSS constellation). More...
 
const char * point_one::fusion_engine::messages::to_string (SolutionType type)
 Get a human-friendly string name for the specified SolutionType. More...
 

Detailed Description

Enumeration Type Documentation

◆ Response

Command response status indicators.

Enumerator
OK 
UNSUPPORTED_CMD_VERSION 

A version specified in the command or subcommand could not be handled.

This could mean that the version was too new, or it was old and there was not a translation for it.

UNSUPPORTED_FEATURE 

The command interacts with a feature that is not present on the target device (e.g., Setting the baud rate on a device without a serial port).

VALUE_ERROR 

One or more values in the command were not in acceptable ranges (e.g., An undefined enum value, or an invalid baud rate).

INSUFFICIENT_SPACE 

The command would require adding too many elements to an internal storage.

EXECUTION_FAILURE 

There was a runtime failure executing the command.

INCONSISTENT_PAYLOAD_LENGTH 

The header payload_size_bytes is in conflict with the size of the message based on its type and type specific length fields.

DATA_CORRUPTED 

Requested data was corrupted and not available.

Definition at line 262 of file defs.h.

◆ SatelliteType

System/constellation type definitions.

Enumerator
UNKNOWN 
GPS 
GLONASS 
LEO 
GALILEO 
BEIDOU 
QZSS 
MIXED 
SBAS 
IRNSS 
MAX_VALUE 

Definition at line 192 of file defs.h.

◆ SolutionType

Navigation solution type definitions.

Enumerator
Invalid 

Invalid, no position available.

AutonomousGPS 

Standalone GNSS fix, no GNSS corrections data used.

DGPS 

Differential GNSS pseudorange solution using a local RTK base station or SSR or SBAS corrections.

RTKFixed 

GNSS RTK solution with fixed integer carrier phase ambiguities (one or more signals fixed).

RTKFloat 

GNSS RTK solution with floating point carrier phase ambiguities.

Integrate 

Integrated position using dead reckoning.

Visual 

Using vision measurements.

PPP 

GNSS precise point positioning (PPP) pseudorange/carrier phase solution.

MAX_VALUE 

Definition at line 341 of file defs.h.

Function Documentation

◆ operator<<() [1/4]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream,
MessageType  type 
)
inline

MessageType stream operator.

Definition at line 184 of file defs.h.

◆ operator<<() [2/4]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream,
Response  val 
)
inline

Response stream operator.

Definition at line 333 of file defs.h.

◆ operator<<() [3/4]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream,
SatelliteType  type 
)
inline

SatelliteType stream operator.

Definition at line 256 of file defs.h.

◆ operator<<() [4/4]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream,
SolutionType  type 
)
inline

SolutionType stream operator.

Definition at line 412 of file defs.h.

◆ to_string() [1/4]

const char* point_one::fusion_engine::messages::to_string ( MessageType  type)
inline

Get a human-friendly string name for the specified MessageType.

Parameters
typeThe desired message type.
Returns
The corresponding string name.

Definition at line 91 of file defs.h.

◆ to_string() [2/4]

const char* point_one::fusion_engine::messages::to_string ( Response  val)
inline

Get a human-friendly string name for the specified Response.

Parameters
valThe enum to get the string name for.
Returns
The corresponding string name.

Definition at line 307 of file defs.h.

◆ to_string() [3/4]

const char* point_one::fusion_engine::messages::to_string ( SatelliteType  type)
inline

Get a human-friendly string name for the specified SatelliteType (GNSS constellation).

Parameters
typeThe desired satellite type.
Returns
The corresponding string name.

Definition at line 215 of file defs.h.

◆ to_string() [4/4]

const char* point_one::fusion_engine::messages::to_string ( SolutionType  type)
inline

Get a human-friendly string name for the specified SolutionType.

Parameters
typeThe desired message type.
Returns
The corresponding string name.

Definition at line 377 of file defs.h.