Common Enumeration Definitions

Detailed Description

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,
  point_one::fusion_engine::messages::Response::NO_DATA_STORED = 8, point_one::fusion_engine::messages::Response::UNAVAILABLE = 9, point_one::fusion_engine::messages::Response::UNSUPPORTED_INTERFACE = 10
}
 Command response status indicators. 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

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

GNSS Constellation (System) Definitions

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SatelliteType type)
 Get a human-friendly string name for the specified SatelliteType (GNSS constellation). More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, SatelliteType type)
 SatelliteType stream operator. More...
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (FrequencyBand type)
 Get a human-friendly string name for the specified FrequencyBand. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, FrequencyBand type)
 FrequencyBand stream operator. More...
 

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.

NO_DATA_STORED 

The requested data isn't available.

UNAVAILABLE 

The device is in a state where it can't process the command.

UNSUPPORTED_INTERFACE 

An interface specified in the command is invalid, or unsupported on the target device.

Definition at line 406 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 503 of file defs.h.

Function Documentation

◆ operator<<() [1/5]

p1_ostream& point_one::fusion_engine::messages::operator<< ( p1_ostream stream,
FrequencyBand  type 
)
inline

FrequencyBand stream operator.

Definition at line 271 of file signal_defs.h.

◆ operator<<() [2/5]

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

MessageType stream operator.

Definition at line 304 of file defs.h.

◆ operator<<() [3/5]

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

Response stream operator.

Definition at line 495 of file defs.h.

◆ operator<<() [4/5]

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

SatelliteType stream operator.

Definition at line 91 of file signal_defs.h.

◆ operator<<() [5/5]

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

SolutionType stream operator.

Definition at line 574 of file defs.h.

◆ to_string() [1/5]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( FrequencyBand  type)

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

Parameters
typeThe desired frequency band.
Returns
The corresponding string name.

Definition at line 245 of file signal_defs.h.

◆ to_string() [2/5]

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

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

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

Definition at line 125 of file defs.h.

◆ to_string() [3/5]

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

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 464 of file defs.h.

◆ to_string() [4/5]

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

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 50 of file signal_defs.h.

◆ to_string() [5/5]

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

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

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

Definition at line 539 of file defs.h.