Skip to main content

messages Namespace

Definition

namespace point_one::fusion_engine::messages { ... }

Namespaces Index

namespaceros

Classes Index

structCalibrationStatusMessage

Device calibration status update. More...

structCoarseOrientation

The orientation of a device with respect to the vehicle body axes. More...

structCommandResponseMessage

Response to indicate if command was processed successfully (MessageType::COMMAND_RESPONSE, version 1.0). More...

structConfigResponseMessage

Response to a GetConfigMessage request (MessageType::CONFIG_RESPONSE, version 1.0). More...

structDataVersion

A struct representing the version of a data object. More...

structDeprecatedVehicleSpeedMeasurement

(Deprecated) Vehicle body speed measurement (MessageType::DEPRECATED_VEHICLE_SPEED_MEASUREMENT, version 1.0). More...

structDeprecatedWheelSpeedMeasurement

(Deprecated) Differential wheel speed measurement (MessageType::DEPRECATED_WHEEL_SPEED_MEASUREMENT, version 1.0). More...

structDeviceIDMessage

Device identifier information (MessageType::DEVICE_ID, version 1.0). More...

structEventNotificationMessage

Notification of a system event for logging purposes (MessageType::EVENT_NOTIFICATION, version 1.0). More...

structExportDataMessage

Export data from the device (MessageType::EXPORT_DATA, version 1.0). More...

structFaultControlMessage

Enable/disable a specified system fault (MessageType::FAULT_CONTROL, version 1.0). More...

structGetConfigMessage

Query the value of a user configuration parameter (MessageType::GET_CONFIG, version 1.1). More...

structGetMessageRate

Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1.0). More...

structGNSSAttitudeOutput

Multi-antenna GNSS attitude sensor measurement output with offset corrections applied (MessageType::GNSS_ATTITUDE_OUTPUT, version 1.0). More...

structGNSSInfoMessage

Information about the GNSS data used in the PoseMessage with the corresponding timestamp (MessageType::GNSS_INFO, version 1.1). More...

structGNSSSatelliteInfo

Information about an individual satellite (see GNSSSignalsMessage). More...

structGNSSSatelliteMessage

Information about the individual satellites used in the PoseMessage and GNSSInfoMessage with the corresponding timestamp (MessageType::GNSS_SATELLITE, version 1.0). More...

structGNSSSignalInfo

Information about an individual GNSS signal (see GNSSSignalsMessage). More...

structGNSSSignalsMessage

Information about the individual GNSS satellites and signals used in the PoseMessage and GNSSInfoMessage with the corresponding timestamp (MessageType::GNSS_SIGNALS, version 1.1). More...

structHardwareTickConfig

Hardware wheel tick encoder configuration settings. More...

structImportDataMessage

Import data from the host to the device (MessageType::IMPORT_DATA, version 1.0). More...

structIMUInput

IMU sensor measurement input (MessageType::IMU_INPUT, version 1.0). More...

structIMUOutput

IMU sensor measurement output with calibration and corrections applied (MessageType::IMU_OUTPUT, version 1.0). More...

structInputDataWrapperMessage

A block of incoming sensor data whose definition depends on the value of @ ref data_type. More...

structInterfaceConfigSubmessage

I/O interface parameter configuration submessage (used when sending a SetConfigMessage or GetConfigMessage for ConfigType::INTERFACE_CONFIG). More...

structInterfaceID

Identifier for an I/O interface. More...

structIonosphereConfig

Ionospheric delay model configuration. More...

structLBandConfig

L-band demodulator configuration parameters. More...

structLBandFrameMessage

L-band frame contents (MessageType::LBAND_FRAME, version 1.0). More...

structMeasurementDetails

The time of applicability and additional information for an incoming sensor measurement. More...

structMessageHeader

The header present at the beginning of every message. More...

structMessagePayload

The base class for all message payloads. More...

structMessageRateResponse

Response to a GetMessageRate request (MessageType::MESSAGE_RATE_RESPONSE, version 1.1). More...

structMessageRateResponseEntry

An element of a MessageRateResponse message. More...

structMessageRequest

Request transmission of a specified message type, (MessageType::MESSAGE_REQUEST, version 1.0). More...

structPlatformStorageDataMessage

Message for reporting platform storage data (MessageType::PLATFORM_STORAGE_DATA, version 1.0). More...

structPoint3f

A 3-dimensional vector (used for lever arms, etc.). More...

structPoseAuxMessage

Auxiliary platform pose information (MessageType::POSE_AUX, version 1.0). More...

structPoseMessage

Platform pose solution: position, velocity, attitude (MessageType::POSE, version 1.2). More...

structRawGNSSAttitudeOutput

Raw (uncorrected) GNSS attitude sensor measurement output (MessageType::RAW_GNSS_ATTITUDE_OUTPUT, version 1.0). More...

structRawIMUOutput

Raw (uncorrected) IMU sensor measurement output (MessageType::RAW_IMU_OUTPUT, version 1.0). More...

structRawVehicleSpeedOutput

Raw (uncorrected) vehicle body speed measurement output (MessageType::RAW_VEHICLE_SPEED_OUTPUT, version 1.0). More...

structRawVehicleTickOutput

Raw (uncorrected) single wheel encoder tick output (MessageType::RAW_VEHICLE_TICK_OUTPUT, version 1.0). More...

structRawWheelSpeedOutput

Raw (uncorrected) dfferential wheel speed measurement output (MessageType::RAW_WHEEL_SPEED_OUTPUT, version 1.0). More...

structRawWheelTickOutput

Raw (uncorrected) dfferential wheel encoder tick output (MessageType::RAW_WHEEL_TICK_OUTPUT, version 1.0). More...

structRelativeENUPositionMessage

Relative ENU position to base station (MessageType::RELATIVE_ENU_POSITION, version 1.1). More...

structResetRequest

Perform a software or hardware reset (MessageType::RESET_REQUEST, version 1.0). More...

structSatelliteInfo

Information about an individual satellite (see GNSSSatelliteMessage). More...

structSaveConfigMessage

Save or reload configuration settings (MessageType::SAVE_CONFIG, version 1.0). More...

structSetConfigMessage

Set a user configuration parameter (MessageType::SET_CONFIG, version 1.0). More...

structSetMessageRate

Set the output rate for the requested message types (MessageType::SET_MESSAGE_RATE, version 1.0). More...

structShutdownRequest

Perform a device shutdown (MessageType::SHUTDOWN_REQUEST, version 1.0). More...

structSSRStatusMessage

State-space representation (SSR) GNSS corrections status (MessageType::SSR_STATUS, version 1.3). More...

structSTA5635Command

A command to be sent to an attached STA5635 RF front-end. More...

structSTA5635CommandResponse

Result from an STA5635 sent in response to an STA5635Command. More...

structSTA5635IQData

IQ sample data from an STA5635 (MessageType::STA5635_IQ_DATA, version 1.0). More...

structStartupRequest

Start up a device (MessageType::STARTUP_REQUEST, version 1.0). More...

structSupportedIOInterfacesMessage

A list of transport interfaces supported by the device (MessageType::SUPPORTED_IO_INTERFACES, version 1.0). More...

structSystemStatusMessage

System status information (MessageType::SYSTEM_STATUS, version 1.1). More...

structTimestamp

Generic timestamp representation. More...

structTroposphereConfig

Tropospheric delay model configuration. More...

structVehicleDetails

Information about the vehicle including model and dimensions. More...

structVehicleSpeedInput

Vehicle body speed measurement input (MessageType::VEHICLE_SPEED_INPUT, version 1.0). More...

structVehicleSpeedOutput

Vehicle body speed measurement output with calibration and corrections applied (MessageType::VEHICLE_SPEED_OUTPUT, version 1.0). More...

structVehicleTickInput

Single wheel encoder tick input, representing vehicle body speed (MessageType::VEHICLE_TICK_INPUT, version 1.0). More...

structVersionInfoMessage

Software version information, (MessageType::VERSION_INFO, version 1.0). More...

structWheelConfig

Software vehicle/wheel speed measurement configuration settings. More...

structWheelSpeedInput

Differential wheel speed measurement input (MessageType::WHEEL_SPEED_INPUT, version 1.0). More...

structWheelSpeedOutput

Differential wheel speed measurement output with calibration and corrections applied (MessageType::WHEEL_SPEED_OUTPUT, version 1.0). More...

structWheelTickInput

Differential wheel encoder tick input (MessageType::WHEEL_TICK_INPUT, version 1.0). More...

Enumerations Index

enum classAppliedSpeedType : uint8_t { ... }

The type of vehicle/wheel speed measurements to be applied. More...

enum classBeiDouSignalName : uint8_t { ... }

The name of a signal from a BeiDou satellite. More...

enum classCalibrationStage : uint8_t { ... }

The stages of the device calibration process. More...

enum classCoComType : uint8_t { ... }

The type of COCOM limit to be applied. More...

enum classConfigType : uint16_t { ... }

An identifier for the contents of a parameter configuration message. More...

enum classConfigurationSource : uint8_t { ... }

The type of a device's configuration settings. More...

enum classDataType : uint8_t { ... }

Type of data stored on device. More...

enum classDeviceType : uint8_t { ... }

Identifies a FusionEngine device. More...

enum classFaultType : uint8_t { ... }

Available fault types/control inputs. More...

enum classFrequencyBand : uint8_t { ... }

GNSS frequency band definitions. More...

enum classGalileoSignalName : uint8_t { ... }

The name of a signal from a Galileo satellite. More...

enum classGearType : uint8_t { ... }

The current transmission gear used by the vehicle. More...

enum classGLONASSSignalName : uint8_t { ... }

The name of a signal from a GLONASS satellite. More...

enum classGNSSComponent : uint8_t { ... }

The component being tracked for signals that have separate data and pilot components. More...

enum classGNSSSignalType : uint16_t { ... }

Representation of the combination of GNSS constellation, signal type, and component being tracked (pilot/data). More...

enum classGPSSignalName : uint8_t { ... }

The name of a signal from a GPS satellite. More...

enum classInterfaceConfigType : uint8_t { ... }

An identifier for the contents of a output interface configuration submessage. More...

enum classIonoDelayModel : uint8_t { ... }

The ionospheric delay model to use. More...

enum classMessageRate : uint8_t { ... }

The output rate for a message type on an interface. More...

enum classMessageType : uint16_t { ... }

Identifiers for the defined output message types. More...

enum classNmeaMessageType : uint16_t { ... }

Integer ID for NMEA messages. More...

enum classProtocolType : uint8_t { ... }

The framing protocol of a message. More...

enum classQZSSSignalName : uint8_t { ... }

The name of a signal from a QZSS satellite. More...

enum classResponse : uint8_t { ... }

Command response status indicators. More...

enum classRTKOutputSource : uint8_t { ... }

RTCM output source types. More...

enum classSatelliteType : uint8_t { ... }

System/constellation type definitions. More...

enum classSaveAction : uint8_t { ... }

The type configuration save operation to be performed. More...

enum classSBASSignalName : uint8_t { ... }

The name of a signal from a SBAS satellite. More...

enum classSensorDataSource : uint8_t { ... }

The source of received sensor measurements, if known. More...

enum classSocketType : uint8_t { ... }

The socket type specifying how data is transmitted for UNIX domain sockets. More...

enum classSolutionType : uint8_t { ... }

Navigation solution type definitions. More...

enum classSteeringType : uint8_t { ... }

Indication of which of the vehicle's wheels are steered. More...

enum classSystemTimeSource : uint8_t { ... }

The source of a point_one::fusion_engine::messages::Timestamp used to represent the time of applicability of an incoming sensor measurement. More...

enum classTickDirection : uint8_t { ... }

The way to interpret an incoming voltage signal, used to indicate direction of a hardware wheel tick pulse, if available. More...

enum classTickMode : uint8_t { ... }

The signal edge to use when capturing a wheel tick voltage signal. More...

enum classTransportDirection : uint8_t { ... }

The direction (client/server) for an individual interface. More...

enum classTransportType : uint8_t { ... }

Type of I/O interface transport. More...

enum classTropoDelayModel : uint8_t { ... }

The tropospheric delay model to use. More...

enum classVehicleModel : uint16_t { ... }

The make and model of the vehicle. More...

enum classWheelSensorType : uint8_t { ... }

The type of vehicle/wheel speed measurements produced by the vehicle. More...

Operators Index

constexpr booloperator!= (const DataVersion &a, const DataVersion &b)
constexpr booloperator< (const DataVersion &a, const DataVersion &b)
p1_ostream &operator<< (p1_ostream &stream, CalibrationStage val)

CalibrationStage stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, const DataVersion &ver)

Helper class for printing out X.Y form of DataVersion. More...

constexpr booloperator<= (const DataVersion &a, const DataVersion &b)
constexpr booloperator== (const DataVersion &a, const DataVersion &b)
constexpr booloperator> (const DataVersion &a, const DataVersion &b)
constexpr booloperator>= (const DataVersion &a, const DataVersion &b)
p1_ostream &operator<< (p1_ostream &stream, AppliedSpeedType applied_speed_type)

AppliedSpeedType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, BeiDouSignalName type)

BeiDouSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, CoComType type)

CoComType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, ConfigType type)

ConfigType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, ConfigurationSource source)

ConfigurationSource stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, const InterfaceID &val)

InterfaceID stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, DataType val)

DataType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, DeviceType val)

DeviceType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, FaultType type)

ConfigurationSource stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, FrequencyBand type)

FrequencyBand stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GalileoSignalName type)

GalileoSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GearType val)

GearType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GLONASSSignalName type)

GLONASSSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GNSSComponent type)

GNSSComponent stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GNSSSignalType type)

GNSSSignalType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, GPSSignalName type)

GPSSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, InterfaceConfigType type)

InterfaceConfigType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, IonoDelayModel iono_delay_model)

IonoDelayModel stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, MessageRate val)

MessageRate stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, MessageType type)

MessageType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, NmeaMessageType val)

NmeaMessageType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, ProtocolType val)

ProtocolType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, QZSSSignalName type)

QZSSSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, Response val)

Response stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, RTKOutputSource source)

RTKOutputSource stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SatelliteType type)

SatelliteType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SaveAction action)

SaveAction stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SBASSignalName type)

SBASSignalName stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SensorDataSource val)

SensorDataSource stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SocketType val)

SocketType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SolutionType type)

SolutionType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SteeringType steering_type)

SteeringType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, SystemTimeSource val)

SystemTimeSource stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, TickDirection tick_direction)

TickDirection stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, TickMode tick_mode)

TickMode stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, TransportDirection val)

TransportDirection stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, TransportType val)

TransportType stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, TropoDelayModel tropo_delay_model)

TropoDelayModel stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, VehicleModel vehicle_model)

VehicleModel stream operator. More...

p1_ostream &operator<< (p1_ostream &stream, WheelSensorType wheel_sensor_type)

WheelSensorType stream operator. More...

Functions Index

DataVersionFromString (const char *str)
DataVersionFromString (std::string str)
template <typename T>
P1_CONSTEXPR_FUNC boolIsSignalNameType ()

Compile time check for whether a type is one of the SignalName enums. More...

P1_CONSTEXPR_FUNC const char *to_string (CalibrationStage val)

Get a human-friendly string name for the specified CalibrationStage. More...

P1_CONSTEXPR_FUNC const char *to_string (IonoDelayModel iono_delay_model)
P1_CONSTEXPR_FUNC const char *to_string (TickDirection tick_direction)
P1_CONSTEXPR_FUNC const char *to_string (TickMode tick_mode)
P1_CONSTEXPR_FUNC const char *to_string (TropoDelayModel tropo_delay_model)
std::stringToString (const DataVersion &ver)
uint32_tCalculateCRC (const void *buffer)

Calculate the CRC for the message (header + payload) contained in the buffer. More...

uint32_tCalculateCRC (const void *buffer, size_t length, uint32_t initial_value=0)

Calculate the CRC for the message (payload) contained in the buffer. More...

P1_CONSTEXPR_FUNC BeiDouSignalNameGetBeiDouSignalName (GNSSSignalType signal_type)

Extract the BeiDouSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC FrequencyBandGetFrequencyBand (GNSSSignalType signal_type)

Extract the FrequencyBand enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GalileoSignalNameGetGalileoSignalName (GNSSSignalType signal_type)

Extract the GalileoSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GLONASSSignalNameGetGLONASSSignalName (GNSSSignalType signal_type)

Extract the GLONASSSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GNSSComponentGetGNSSComponent (GNSSSignalType signal_type)

Extract the GNSSComponent enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC GPSSignalNameGetGPSSignalName (GNSSSignalType signal_type)

Extract the GPSSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC QZSSSignalNameGetQZSSSignalName (GNSSSignalType signal_type)

Extract the QZSSSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC SatelliteTypeGetSatelliteType (GNSSSignalType signal_type)

Extract the SatelliteType enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC SBASSignalNameGetSBASSignalName (GNSSSignalType signal_type)

Extract the SBASSignalName enum value from a GNSSSignalType. More...

P1_CONSTEXPR_FUNC boolIsCommand (const MessageHeader &header)

Check if the specified message is a user command. More...

P1_CONSTEXPR_FUNC boolIsCommand (MessageType message_type)

Check if the specified message type is a user command. More...

P1_CONSTEXPR_FUNC boolIsResponse (const MessageHeader &header)

Check if the specified message type is a response to a user command. More...

P1_CONSTEXPR_FUNC boolIsResponse (MessageType message_type)

Check if the specified message type is a response to a user command. More...

boolIsValid (const void *buffer)

Check if the message contained in the buffer has a valid CRC. More...

P1_CONSTEXPR_FUNC const char *to_string (AppliedSpeedType applied_speed_type)

Get a human-friendly string name for the specified AppliedSpeedType. More...

P1_CONSTEXPR_FUNC const char *to_string (BeiDouSignalName type)

Get a string representation of the BeiDouSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (CoComType type)

Get a human-friendly string name for the specified CoComType. More...

P1_CONSTEXPR_FUNC const char *to_string (ConfigType type)

Get a human-friendly string name for the specified ConfigType. More...

P1_CONSTEXPR_FUNC const char *to_string (ConfigurationSource source)

Get a human-friendly string name for the specified ConfigurationSource. More...

P1_CONSTEXPR_FUNC const char *to_string (DataType type)

Get a string representation of a DataType. More...

P1_CONSTEXPR_FUNC const char *to_string (DeviceType val)

Get a human-friendly string name for the specified DeviceType. More...

P1_CONSTEXPR_FUNC const char *to_string (FaultType type)

Get a human-friendly string name for the specified FaultType. More...

P1_CONSTEXPR_FUNC const char *to_string (FrequencyBand type)

Get a string representation of the FrequencyBand enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GalileoSignalName type)

Get a string representation of the GalileoSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GearType val)

Get a human-friendly string name for the specified GearType. More...

P1_CONSTEXPR_FUNC const char *to_string (GLONASSSignalName type)

Get a string representation of the GLONASSSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GNSSComponent type)

Get a string representation of the GNSSComponent enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GNSSSignalType type)

Get a string representation of the GNSSSignalType enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (GPSSignalName type)

Get a string representation of the GPSSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (InterfaceConfigType type)

Get a human-friendly string name for the specified ConfigType. More...

P1_CONSTEXPR_FUNC const char *to_string (MessageRate value)

Get a human-friendly string name for the specified MessageRate. More...

P1_CONSTEXPR_FUNC const char *to_string (MessageType type)

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

P1_CONSTEXPR_FUNC const char *to_string (NmeaMessageType value)

Get a human-friendly string name for the specified NmeaMessageType. More...

P1_CONSTEXPR_FUNC const char *to_string (ProtocolType val)

Get a human-friendly string name for the specified ProtocolType. More...

P1_CONSTEXPR_FUNC const char *to_string (QZSSSignalName type)

Get a string representation of the QZSSSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (Response val)

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

P1_CONSTEXPR_FUNC const char *to_string (RTKOutputSource source)

Get a human-friendly string name for the specified RTKOutputSource. More...

P1_CONSTEXPR_FUNC const char *to_string (SatelliteType type)

Get a string representation of the SatelliteType enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (SaveAction action)

Get a human-friendly string name for the specified SaveAction. More...

P1_CONSTEXPR_FUNC const char *to_string (SBASSignalName type)

Get a string representation of the SBASSignalName enum value. More...

P1_CONSTEXPR_FUNC const char *to_string (SensorDataSource val)

Get a human-friendly string name for the specified SensorDataSource. More...

P1_CONSTEXPR_FUNC const char *to_string (SocketType val)

Get a human-friendly string name for the specified SocketType. More...

P1_CONSTEXPR_FUNC const char *to_string (SolutionType type)

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

P1_CONSTEXPR_FUNC const char *to_string (SteeringType steering_type)

Get a human-friendly string name for the specified SteeringType. More...

P1_CONSTEXPR_FUNC const char *to_string (SystemTimeSource val)

Get a human-friendly string name for the specified SystemTimeSource. More...

P1_CONSTEXPR_FUNC const char *to_string (TransportDirection val)

Get a human-friendly string name for the specified TransportDirection. More...

P1_CONSTEXPR_FUNC const char *to_string (TransportType val)

Get a human-friendly string name for the specified TransportType. More...

P1_CONSTEXPR_FUNC const char *to_string (VehicleModel vehicle_model)

Get a human-friendly string name for the specified VehicleModel. More...

P1_CONSTEXPR_FUNC const char *to_string (WheelSensorType wheel_sensor_type)

Get a human-friendly string name for the specified WheelSensorType. More...

template <typename... Args>
P1_CONSTEXPR_FUNC uint32_tToBitMask (FrequencyBand first, Args... others)

Convert two or more FrequencyBand values to a bitmask. More...

P1_CONSTEXPR_FUNC uint32_tToBitMask (FrequencyBand type)

Convert a FrequencyBand to a corresponding frequency control bitmask value. More...

template <typename... Args>
P1_CONSTEXPR_FUNC uint32_tToBitMask (SatelliteType first, Args... others)

Convert two or more SatelliteType values to a bitmask. More...

P1_CONSTEXPR_FUNC uint32_tToBitMask (SatelliteType type)

Convert a SatelliteType to a corresponding constellation control bitmask value. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (BeiDouSignalName type)

Get a human-friendly string for the specified BeiDouSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (FrequencyBand type)

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

P1_CONSTEXPR_FUNC const char *ToPrettyString (GalileoSignalName type)

Get a human-friendly string for the specified GalileoSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GLONASSSignalName type)

Get a human-friendly string for the specified GLONASSSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GNSSComponent type)

Get a human-friendly string for the specified GNSSComponent. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GNSSSignalType type)

Get a human-friendly string for the specified GNSSSignalType. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (GPSSignalName type)

Get a human-friendly string for the specified GPSSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (QZSSSignalName type)

Get a human-friendly string for the specified QZSSSignalName. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (SatelliteType type)

Get a human-friendly string for the specified SatelliteType. More...

P1_CONSTEXPR_FUNC const char *ToPrettyString (SBASSignalName type)

Get a human-friendly string for the specified SBASSignalName. More...

template <typename SignalName>
P1_CONSTEXPR_FUNC GNSSSignalTypeToSignalType (SatelliteType sv_type, FrequencyBand freq_band, SignalName signal_name, GNSSComponent component)

Create a GNSSSignalType from the enums that it's made up from. More...

template <typename SignalName>
constexpr uint16_tToSignalVal (SatelliteType sv_type, FrequencyBand freq_band, SignalName signal_name, GNSSComponent component)

Create a GNSSSignalType from the enums that it's made up from. More...

const char *ToString (BeiDouSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (FrequencyBand type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GalileoSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GLONASSSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GNSSComponent type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GNSSSignalType type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (GPSSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (QZSSSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (SatelliteType type)

Get a human-friendly string name for the specified ConfigType. More...

const char *ToString (SBASSignalName type)

Get a human-friendly string name for the specified ConfigType. More...

Variables Index

constexpr uint16_tALL_MESSAGES_ID = 0xFFFF

Setting message_id to this value acts as a wild card. More...

constexpr unsignedFREQUENCY_BAND_BITS = 4
constexpr unsignedFREQUENCY_BAND_SHIFT = 6
constexpr unsignedGNSS_COMPONENT_BITS = 2
constexpr unsignedGNSS_COMPONENT_SHIFT = 0
constexpr DataVersionINVALID_DATA_VERSION
constexpr unsignedSATELLITE_TYPE_BITS = 4
constexpr unsignedSATELLITE_TYPE_SHIFT = 12
constexpr unsignedSIGNAL_NAME_BITS = 3
constexpr unsignedSIGNAL_NAME_SHIFT = 2
static constexpr uint32_tFREQUENCY_BAND_MASK_ALL = 0xFFFFFFFF
static constexpr uint32_tFREQUENCY_BAND_MASK_L1 = ...
static constexpr uint32_tFREQUENCY_BAND_MASK_L2 = ...
static constexpr uint32_tFREQUENCY_BAND_MASK_L5 = ...
static constexpr uint32_tFREQUENCY_BAND_MASK_L6 = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_ALL = 0xFFFFFFFF
static constexpr uint32_tSATELLITE_TYPE_MASK_BEIDOU = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_GALILEO = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_GLONASS = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_GPS = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_IRNSS = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_LEO = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_MIXED = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_QZSS = ...
static constexpr uint32_tSATELLITE_TYPE_MASK_SBAS = ...

Operators

operator!=()

constexpr bool point_one::fusion_engine::messages::operator!= (const DataVersion & a, const DataVersion & b)
inline constexpr

Definition at line 53 of file data_version.h.

53inline constexpr bool operator!=(const DataVersion& a, const DataVersion& b) {
54 return !(a == b);
55}

operator<()

constexpr bool point_one::fusion_engine::messages::operator< (const DataVersion & a, const DataVersion & b)
inline constexpr

Definition at line 57 of file data_version.h.

57inline constexpr bool operator<(const DataVersion& a, const DataVersion& b) {
58 return a.major_version < b.major_version ||
59 (a.major_version == b.major_version &&
60 a.minor_version < b.minor_version);
61}

operator<<()

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

CalibrationStage stream operator.

Definition at line 565 of file solution.h.

566 stream << to_string(val) << " (" << (int)val << ")";
567 return stream;
568}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, const DataVersion & ver)

Helper class for printing out X.Y form of DataVersion.

 DataVersion ver{3, 2};
 std::cout << "Ver: " << ver;
 // Ver: 3.2

Definition at line 9 of file data_version.cc.

10 if (ver.IsValid()) {
11 return stream << (int)ver.major_version << "." << ver.minor_version;
12 } else {
13 return stream << "<invalid>";
14 }
15}

operator<=()

constexpr bool point_one::fusion_engine::messages::operator<= (const DataVersion & a, const DataVersion & b)
inline constexpr

Definition at line 67 of file data_version.h.

67inline constexpr bool operator<=(const DataVersion& a, const DataVersion& b) {
68 return !(a > b);
69}

operator==()

constexpr bool point_one::fusion_engine::messages::operator== (const DataVersion & a, const DataVersion & b)
inline constexpr

Definition at line 48 of file data_version.h.

48inline constexpr bool operator==(const DataVersion& a, const DataVersion& b) {
49 return a.major_version == b.major_version &&
50 a.minor_version == b.minor_version;
51}

operator>()

constexpr bool point_one::fusion_engine::messages::operator> (const DataVersion & a, const DataVersion & b)
inline constexpr

Definition at line 63 of file data_version.h.

63inline constexpr bool operator>(const DataVersion& a, const DataVersion& b) {
64 return b < a;
65}

operator>=()

constexpr bool point_one::fusion_engine::messages::operator>= (const DataVersion & a, const DataVersion & b)
inline constexpr

Definition at line 71 of file data_version.h.

71inline constexpr bool operator>=(const DataVersion& a, const DataVersion& b) {
72 return !(a < b);
73}

Functions

FromString()

DataVersion point_one::fusion_engine::messages::FromString (const char * str)

Definition at line 26 of file data_version.cc.

27 char* end_c = nullptr;
28 long tmp = 0;
29 DataVersion version;
30
31 tmp = strtol(str, &end_c, 10);
32 if (end_c == str || tmp > 255 || tmp < 0) {
34 }
35 version.major_version = (uint8_t)tmp;
36
37 const char* minor_str = end_c + 1;
38
39 tmp = strtol(minor_str, &end_c, 10);
40 if (end_c == minor_str || tmp > 65535 || tmp < 0) {
42 }
43 version.minor_version = (uint16_t)tmp;
44
45 return version;
46}

FromString()

DataVersion point_one::fusion_engine::messages::FromString (std::string str)
inline

Definition at line 90 of file data_version.h.

90inline DataVersion FromString(std::string str) {
91 return FromString(str.c_str());
92}

IsSignalNameType()

template <typename T>
P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::IsSignalNameType ()

Compile time check for whether a type is one of the SignalName enums.

Template Parameters
T

The type to check.

Returns

true, if T is a SignalName enum. Return false otherwise.

Definition at line 48 of file signal_defs.h.

49 return std::is_same<T, GPSSignalName>::value ||
50 std::is_same<T, GLONASSSignalName>::value ||
51 std::is_same<T, BeiDouSignalName>::value ||
52 std::is_same<T, GalileoSignalName>::value ||
53 std::is_same<T, SBASSignalName>::value ||
54 std::is_same<T, QZSSSignalName>::value;
55}

to_string()

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

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

Parameters
val

The enum to get the string name for.

Returns

The corresponding string name.

Definition at line 550 of file solution.h.

551 switch (val) {
553 return "Unknown";
555 return "IMU Mounting Angles";
557 return "Done";
558 }
559 return "Unrecognized";
560}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (IonoDelayModel iono_delay_model)

Definition at line 1254 of file configuration.h.

1254P1_CONSTEXPR_FUNC const char* to_string(IonoDelayModel iono_delay_model) {
1255 switch (iono_delay_model) {
1257 return "AUTO";
1259 return "OFF";
1261 return "KLOBUCHAR";
1263 return "SBAS";
1264 }
1265
1266 return "UNRECOGNIZED";
1267}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TickDirection tick_direction)

Definition at line 1163 of file configuration.h.

1163P1_CONSTEXPR_FUNC const char* to_string(TickDirection tick_direction) {
1164 switch (tick_direction) {
1166 return "OFF";
1168 return "FORWARD_ACTIVE_HIGH";
1170 return "FORWARD_ACTIVE_LOW";
1171 }
1172
1173 return "UNRECOGNIZED";
1174}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TickMode tick_mode)

Definition at line 1121 of file configuration.h.

1121P1_CONSTEXPR_FUNC const char* to_string(TickMode tick_mode) {
1122 switch (tick_mode) {
1123 case TickMode::OFF:
1124 return "OFF";
1126 return "RISING_EDGE";
1128 return "FALLING_EDGE";
1129 }
1130
1131 return "UNRECOGNIZED";
1132}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TropoDelayModel tropo_delay_model)

Definition at line 1303 of file configuration.h.

1303P1_CONSTEXPR_FUNC const char* to_string(TropoDelayModel tropo_delay_model) {
1304 switch (tropo_delay_model) {
1306 return "AUTO";
1308 return "OFF";
1310 return "SAASTAMOINEN";
1311 }
1312
1313 return "UNRECOGNIZED";
1314}

ToString()

std::string point_one::fusion_engine::messages::ToString (const DataVersion & ver)

Definition at line 17 of file data_version.cc.

17std::string ToString(const DataVersion& ver) {
18 if (ver.IsValid()) {
19 return std::to_string(ver.major_version) + "." +
20 std::to_string(ver.minor_version);
21 } else {
22 return "<invalid>";
23 }
24}

Variables

ALL_MESSAGES_ID

constexpr uint16_t point_one::fusion_engine::messages::ALL_MESSAGES_ID = 0xFFFF
constexpr

Setting message_id to this value acts as a wild card.

Definition at line 1689 of file configuration.h.

1689constexpr uint16_t ALL_MESSAGES_ID = 0xFFFF;

FREQUENCY_BAND_BITS

constexpr unsigned point_one::fusion_engine::messages::FREQUENCY_BAND_BITS = 4
constexpr

Definition at line 32 of file signal_defs.h.

32constexpr unsigned FREQUENCY_BAND_BITS = 4;

FREQUENCY_BAND_SHIFT

constexpr unsigned point_one::fusion_engine::messages::FREQUENCY_BAND_SHIFT = 6
constexpr

Definition at line 31 of file signal_defs.h.

31constexpr unsigned FREQUENCY_BAND_SHIFT = 6;

GNSS_COMPONENT_BITS

constexpr unsigned point_one::fusion_engine::messages::GNSS_COMPONENT_BITS = 2
constexpr

Definition at line 36 of file signal_defs.h.

36constexpr unsigned GNSS_COMPONENT_BITS = 2;

GNSS_COMPONENT_SHIFT

constexpr unsigned point_one::fusion_engine::messages::GNSS_COMPONENT_SHIFT = 0
constexpr

Definition at line 35 of file signal_defs.h.

35constexpr unsigned GNSS_COMPONENT_SHIFT = 0;

INVALID_DATA_VERSION

constexpr DataVersion point_one::fusion_engine::messages::INVALID_DATA_VERSION
constexpr

Definition at line 46 of file data_version.h.

SATELLITE_TYPE_BITS

constexpr unsigned point_one::fusion_engine::messages::SATELLITE_TYPE_BITS = 4
constexpr

Definition at line 30 of file signal_defs.h.

30constexpr unsigned SATELLITE_TYPE_BITS = 4;

SATELLITE_TYPE_SHIFT

constexpr unsigned point_one::fusion_engine::messages::SATELLITE_TYPE_SHIFT = 12
constexpr

Definition at line 29 of file signal_defs.h.

29constexpr unsigned SATELLITE_TYPE_SHIFT = 12;

SIGNAL_NAME_BITS

constexpr unsigned point_one::fusion_engine::messages::SIGNAL_NAME_BITS = 3
constexpr

Definition at line 34 of file signal_defs.h.

34constexpr unsigned SIGNAL_NAME_BITS = 3;

SIGNAL_NAME_SHIFT

constexpr unsigned point_one::fusion_engine::messages::SIGNAL_NAME_SHIFT = 2
constexpr

Definition at line 33 of file signal_defs.h.

33constexpr unsigned SIGNAL_NAME_SHIFT = 2;

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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.