Message Definitions

Detailed Description

Type definitions for all defined messages.

See also MessageType.

Modules
	Device Configuration and Control Message Definitions
	Messages for controlling device configuration and operation.
	Sensor Measurement Message Definitions
	Measurement data from available sensors.
	ROS Support Message Definitions
	Messages designed for direct translation to ROS.
	Navigation Solution Message Definitions
	Output messages containing position, navigation, and time results.

Classes
struct	point_one::fusion_engine::messages::MessageHeader
	The header present at the beginning of every message. More...
struct	point_one::fusion_engine::messages::MessagePayload
	The base class for all message payloads. More...

Enumerations
enum	point_one::fusion_engine::messages::MessageType : uint16_t {   point_one::fusion_engine::messages::MessageType::INVALID = 0, point_one::fusion_engine::messages::MessageType::POSE = 10000, point_one::fusion_engine::messages::MessageType::GNSS_INFO = 10001, point_one::fusion_engine::messages::MessageType::GNSS_SATELLITE = 10002,   point_one::fusion_engine::messages::MessageType::POSE_AUX = 10003, point_one::fusion_engine::messages::MessageType::CALIBRATION_STATUS = 10004, point_one::fusion_engine::messages::MessageType::RELATIVE_ENU_POSITION = 10005, point_one::fusion_engine::messages::MessageType::IMU_MEASUREMENT = 11000,   point_one::fusion_engine::messages::MessageType::HEADING_MEASUREMENT = 11001, point_one::fusion_engine::messages::MessageType::WHEEL_SPEED_MEASUREMENT = 11101, point_one::fusion_engine::messages::MessageType::VEHICLE_SPEED_MEASUREMENT = 11102, point_one::fusion_engine::messages::MessageType::WHEEL_TICK_MEASUREMENT = 11103,   point_one::fusion_engine::messages::MessageType::VEHICLE_TICK_MEASUREMENT = 11104, point_one::fusion_engine::messages::MessageType::ROS_POSE = 12000, point_one::fusion_engine::messages::MessageType::ROS_GPS_FIX = 12010, point_one::fusion_engine::messages::MessageType::ROS_IMU = 12011,   point_one::fusion_engine::messages::MessageType::COMMAND_RESPONSE = 13000, point_one::fusion_engine::messages::MessageType::MESSAGE_REQUEST = 13001, point_one::fusion_engine::messages::MessageType::RESET_REQUEST = 13002, point_one::fusion_engine::messages::MessageType::VERSION_INFO = 13003,   point_one::fusion_engine::messages::MessageType::EVENT_NOTIFICATION = 13004, point_one::fusion_engine::messages::MessageType::SHUTDOWN_REQUEST = 13005, point_one::fusion_engine::messages::MessageType::FAULT_CONTROL = 13006, point_one::fusion_engine::messages::MessageType::SET_CONFIG = 13100,   point_one::fusion_engine::messages::MessageType::GET_CONFIG = 13101, point_one::fusion_engine::messages::MessageType::SAVE_CONFIG = 13102, point_one::fusion_engine::messages::MessageType::CONFIG_RESPONSE = 13103, point_one::fusion_engine::messages::MessageType::IMPORT_DATA = 13110,   point_one::fusion_engine::messages::MessageType::EXPORT_DATA = 13111, point_one::fusion_engine::messages::MessageType::PLATFORM_STORAGE_DATA = 13113, point_one::fusion_engine::messages::MessageType::SET_MESSAGE_RATE = 13220, point_one::fusion_engine::messages::MessageType::GET_MESSAGE_RATE = 13221,   point_one::fusion_engine::messages::MessageType::MESSAGE_RATE_RESPONSE = 13222, point_one::fusion_engine::messages::MessageType::MAX_VALUE = MESSAGE_RATE_RESPONSE }
	Identifiers for the defined output message types. More...

Functions
P1_CONSTEXPR_FUNC bool	point_one::fusion_engine::messages::IsCommand (const MessageHeader &header)
	Check if the specified message is a user command. More...
P1_CONSTEXPR_FUNC bool	point_one::fusion_engine::messages::IsCommand (MessageType message_type)
	Check if the specified message type is a user command. More...
P1_CONSTEXPR_FUNC bool	point_one::fusion_engine::messages::IsResponse (const MessageHeader &header)
	Check if the specified message type is a response to a user command. More...
P1_CONSTEXPR_FUNC bool	point_one::fusion_engine::messages::IsResponse (MessageType message_type)
	Check if the specified message type is a response to a user command. More...

Enumeration Type Documentation

MessageType

enum point_one::fusion_engine::messages::MessageType : uint16_t

strong

Identifiers for the defined output message types.

Enumerator
INVALID	Invalid message type.
POSE	PoseMessage
GNSS_INFO	GNSSInfoMessage
GNSS_SATELLITE	GNSSSatelliteMessage
POSE_AUX	PoseAuxMessage
CALIBRATION_STATUS	CalibrationStatusMessage
RELATIVE_ENU_POSITION	RelativeENUPositionMessage
IMU_MEASUREMENT	IMUMeasurement
HEADING_MEASUREMENT	HeadingMeasurement
WHEEL_SPEED_MEASUREMENT	WheelSpeedMeasurement
VEHICLE_SPEED_MEASUREMENT	VehicleSpeedMeasurement
WHEEL_TICK_MEASUREMENT	WheelTickMeasurement
VEHICLE_TICK_MEASUREMENT	VehicleTickMeasurement
ROS_POSE	ros::PoseMessage
ROS_GPS_FIX	ros::GPSFixMessage
ROS_IMU	ros::IMUMessage
COMMAND_RESPONSE	CommandResponseMessage
MESSAGE_REQUEST	MessageRequest
RESET_REQUEST	ResetRequest
VERSION_INFO	VersionInfoMessage
EVENT_NOTIFICATION	EventNotificationMessage
SHUTDOWN_REQUEST	ShutdownRequest
FAULT_CONTROL	FaultControlMessage
SET_CONFIG	SetConfigMessage
GET_CONFIG	GetConfigMessage
SAVE_CONFIG	SaveConfigMessage
CONFIG_RESPONSE	ConfigResponseMessage
IMPORT_DATA	ImportDataMessage
EXPORT_DATA	ExportDataMessage
PLATFORM_STORAGE_DATA	PlatformStorageDataMessage
SET_MESSAGE_RATE	SetMessageRate
GET_MESSAGE_RATE	GetMessageRate
MESSAGE_RATE_RESPONSE	MessageRateResponse
MAX_VALUE	The maximum defined MessageType enum value.

Definition at line 35 of file defs.h.

Function Documentation

IsCommand() [1/2]

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::IsCommand

(

const MessageHeader &

header

)

Check if the specified message is a user command.

See IsCommand() for details.

Parameters

header

Header of a received FusionEngine message.

Returns

true if the message is a FusionEngine command.

Definition at line 518 of file defs.h.

IsCommand() [2/2]

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::IsCommand

(

MessageType

message_type

)

Check if the specified message type is a user command.

See also IsResponse().

Parameters

message_type

The message type in question.

Returns

true if the message is a FusionEngine command.

Definition at line 224 of file defs.h.

IsResponse() [1/2]

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::IsResponse

(

const MessageHeader &

header

)

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

See IsResponse() for details.

Parameters

header

Header of a received FusionEngine message.

Returns

true if the message is a FusionEngine command response.

Definition at line 532 of file defs.h.

IsResponse() [2/2]

P1_CONSTEXPR_FUNC bool point_one::fusion_engine::messages::IsResponse

(

MessageType

message_type

)

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

See also IsCommand().

Parameters

message_type

The message type in question.

Returns

true if the message is a FusionEngine command response.

Definition at line 253 of file defs.h.