RawVehicleTickOutput Struct

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

Declaration

struct point_one::fusion_engine::messages::RawVehicleTickOutput { ... }

Included Headers

#include <point_one/fusion_engine/messages/measurements.h>

Base struct

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

Public Member Attributes Index

MeasurementDetails	details
	Measurement timestamp and additional information, if available. More...
GearType	gear = GearType::UNKNOWN
	The transmission gear currently in use, or direction of motion, if available. More...
uint32_t	tick_count = 0
	The current encoder tick count. More...

Public Static Attributes Index

static constexpr MessageType	MESSAGE_TYPE = ...
static constexpr uint8_t	MESSAGE_VERSION = 0

Description

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

This message is an output from the device that contains a wheel encoder tick count representing the along-track speed of the vehicle (forward/backward). Wheel ticks may be captured in hardware from an external voltage pulse, conveyed via software using a VehicleTickInput message, or decoded from a vehicle CAN bus. The interpretation of the tick count values varies by vehicle.

This value comes directly from the sensor, and does not have any corrections or calibration applied.

See also VehicleTickInput.

Definition at line 1007 of file measurements.h.

Public Member Attributes

details

MeasurementDetails point_one::fusion_engine::messages::RawVehicleTickOutput::details

Measurement timestamp and additional information, if available.

See MeasurementDetails for details.

Definition at line 1016 of file measurements.h.

1016 MeasurementDetails details;

gear

GearType point_one::fusion_engine::messages::RawVehicleTickOutput::gear = GearType::UNKNOWN

The transmission gear currently in use, or direction of motion, if available.

Set to GearType::FORWARD or GearType::REVERSE where vehicle direction information is available externally.

Definition at line 1031 of file measurements.h.

1031 GearType gear = GearType::UNKNOWN;

tick_count

uint32_t point_one::fusion_engine::messages::RawVehicleTickOutput::tick_count = 0

The current encoder tick count.

The interpretation of these ticks is defined outside of this message.

Definition at line 1022 of file measurements.h.

1022 uint32_t tick_count = 0;

Public Static Attributes

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::RawVehicleTickOutput::MESSAGE_TYPE

constexpr static

Initialiser

= MessageType::RAW_VEHICLE_TICK_OUTPUT

Definition at line 1008 of file measurements.h.

1008 static constexpr MessageType MESSAGE_TYPE =

MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::RawVehicleTickOutput::MESSAGE_VERSION = 0

constexpr static

Definition at line 1010 of file measurements.h.

1010 static constexpr uint8_t MESSAGE_VERSION = 0;

---

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

• measurements.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.