Common Enumeration Definitions
Topics Index
| Enums and helper functions for describing GNSS | |
|
satellites and their signals. More... | |
Enumerations Index
| enum class | Response : uint8_t { ... } |
|
Command response status indicators. More... | |
| enum class | SolutionType : uint8_t { ... } |
|
Navigation solution type definitions. More... | |
Operators Index
| p1_ostream & | operator<< (p1_ostream &stream, MessageType type) |
|
MessageType stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, Response val) |
| p1_ostream & | operator<< (p1_ostream &stream, SolutionType type) |
|
SolutionType stream operator. More... | |
Functions Index
| 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 (Response val) |
|
Get a human-friendly string name for the specified Response. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (SolutionType type) |
|
Get a human-friendly string name for the specified SolutionType. More... | |
Enumerations
Response
| strong |
Command response status indicators.
- Enumeration values
Definition at line 416 of file defs.h.
417 OK = 0,
418 /**
419 * A version specified in the command or subcommand could not be handled.
420 * This could mean that the version was too new, or it was old and there was
421 * not a translation for it.
422 */
423 UNSUPPORTED_CMD_VERSION = 1,
424 /**
425 * The command interacts with a feature that is not present on the target
426 * device (e.g., Setting the baud rate on a device without a serial port).
427 */
428 UNSUPPORTED_FEATURE = 2,
429 /**
430 * One or more values in the command were not in acceptable ranges (e.g., An
431 * undefined enum value, or an invalid baud rate).
432 */
433 VALUE_ERROR = 3,
434 /**
435 * The command would require adding too many elements to an internal
436 * storage.
437 */
438 INSUFFICIENT_SPACE = 4,
439 /**
440 * There was a runtime failure executing the command.
441 */
442 EXECUTION_FAILURE = 5,
443 /**
444 * The header `payload_size_bytes` is in conflict with the size of the
445 * message based on its type and type specific length fields.
446 */
447 INCONSISTENT_PAYLOAD_LENGTH = 6,
448 /**
449 * Requested data was corrupted and not available.
450 */
451 DATA_CORRUPTED = 7,
452 /**
453 * The requested data isn't available.
454 */
455 NO_DATA_STORED = 8,
456 /**
457 * The device is in a state where it can't process the command.
458 */
459 UNAVAILABLE = 9,
460 /**
461 * An interface specified in the command is invalid, or unsupported on the
462 * target device.
463 */
464 UNSUPPORTED_INTERFACE = 10,
465};
SolutionType
| strong |
Navigation solution type definitions.
- Enumeration values
Definition at line 513 of file defs.h.
513enum class SolutionType : uint8_t {
514 /** Invalid, no position available. */
515 Invalid = 0,
516 /** Standalone GNSS fix, no GNSS corrections data used. */
517 AutonomousGPS = 1,
518 /**
519 * Differential GNSS pseudorange solution using a local RTK base station or
520 * SSR or SBAS corrections.
521 */
522 DGPS = 2,
523 /**
524 * GNSS RTK solution with fixed integer carrier phase ambiguities (one or more
525 * signals fixed).
526 */
527 RTKFixed = 4,
528 /** GNSS RTK solution with floating point carrier phase ambiguities. */
529 RTKFloat = 5,
530 /** Integrated position using dead reckoning. */
531 Integrate = 6,
532 /** Using vision measurements. */
533 Visual = 9,
534 /**
535 * GNSS precise point positioning (PPP) pseudorange/carrier phase solution.
536 */
537 PPP = 10,
539};
Operators
operator<<()
| inline |
MessageType stream operator.
operator<<()
| inline |
Response stream operator.
operator<<()
| inline |
SolutionType stream operator.
Functions
to_string()
|
Get a human-friendly string name for the specified MessageType.
- Parameters
-
type The desired message type.
- Returns
The corresponding string name.
Definition at line 127 of file defs.h.
127P1_CONSTEXPR_FUNC const char* to_string(MessageType type) {
128 switch (type) {
129 case MessageType::INVALID:
130 return "Invalid";
131
132 // Navigation solution messages.
133 case MessageType::POSE:
134 return "Pose";
135
136 case MessageType::GNSS_INFO:
137 return "GNSS Info";
138
139 case MessageType::GNSS_SATELLITE:
140 return "GNSS Satellite";
141
142 case MessageType::POSE_AUX:
143 return "Pose Auxiliary";
144
145 case MessageType::CALIBRATION_STATUS:
146 return "Calibration Status";
147
148 case MessageType::RELATIVE_ENU_POSITION:
149 return "Relative ENU Position";
150
151 case MessageType::GNSS_SIGNALS:
152 return "GNSS Signals";
153
154 // Device status messages.
155 case MessageType::SYSTEM_STATUS:
156 return "System Status";
157
158 case MessageType::SSR_STATUS:
159 return "SSR Status";
160
161 // Sensor measurement messages.
162 case MessageType::IMU_OUTPUT:
163 return "IMU Output";
164
166 return "Raw GNSS Heading Output";
167
168 case MessageType::RAW_IMU_OUTPUT:
169 return "Raw IMU Output";
170
171 case MessageType::DEPRECATED_HEADING_OUTPUT:
172 return "GNSS Heading Output";
173
174 case MessageType::IMU_INPUT:
175 return "IMU Input";
176
177 case MessageType::GNSS_ATTITUDE_OUTPUT:
178 return "GNSS Attitude Output";
179
180 case MessageType::RAW_GNSS_ATTITUDE_OUTPUT:
181 return "Raw GNSS Attitude Output";
182
184 return "Wheel Speed Measurement";
185
187 return "Vehicle Speed Measurement";
188
189 case MessageType::WHEEL_TICK_INPUT:
190 return "Wheel Tick Input";
191
192 case MessageType::VEHICLE_TICK_INPUT:
193 return "Vehicle Tick Input";
194
195 case MessageType::WHEEL_SPEED_INPUT:
196 return "Wheel Speed Input";
197
198 case MessageType::VEHICLE_SPEED_INPUT:
199 return "Vehicle Speed Input";
200
201 case MessageType::RAW_WHEEL_TICK_OUTPUT:
202 return "Raw Wheel Tick Output";
203
204 case MessageType::RAW_VEHICLE_TICK_OUTPUT:
205 return "Raw Vehicle Tick Output";
206
207 case MessageType::RAW_WHEEL_SPEED_OUTPUT:
208 return "Raw Wheel Speed Output";
209
210 case MessageType::RAW_VEHICLE_SPEED_OUTPUT:
211 return "Raw Vehicle Speed Output";
212
213 case MessageType::WHEEL_SPEED_OUTPUT:
214 return "Wheel Speed Output";
215
216 case MessageType::VEHICLE_SPEED_OUTPUT:
217 return "Vehicle Speed Output";
218
219 // ROS messages.
220 case MessageType::ROS_POSE:
221 return "ROS Pose";
222
223 case MessageType::ROS_GPS_FIX:
224 return "ROS GPSFix";
225
226 case MessageType::ROS_IMU:
227 return "ROS IMU";
228
229 // Command and control messages.
230 case MessageType::COMMAND_RESPONSE:
231 return "Command Response";
232
233 case MessageType::MESSAGE_REQUEST:
234 return "Message Transmission Request";
235
236 case MessageType::RESET_REQUEST:
237 return "Reset Request";
238
239 case MessageType::VERSION_INFO:
240 return "Version Information";
241
242 case MessageType::EVENT_NOTIFICATION:
243 return "Event Notification";
244
245 case MessageType::SHUTDOWN_REQUEST:
246 return "Shutdown Request";
247
248 case MessageType::STARTUP_REQUEST:
249 return "Startup Request";
250
251 case MessageType::DEVICE_ID:
252 return "Device ID Information";
253
254 case MessageType::FAULT_CONTROL:
255 return "Fault Control";
256
257 case MessageType::SET_CONFIG:
258 return "Set Configuration Parameter";
259
260 case MessageType::GET_CONFIG:
261 return "Get Configuration Parameter";
262
263 case MessageType::SAVE_CONFIG:
264 return "Save Configuration";
265
266 case MessageType::CONFIG_RESPONSE:
267 return "Configuration Parameter Value";
268
269 case MessageType::SET_MESSAGE_RATE:
270 return "Set Message Rate";
271
272 case MessageType::GET_MESSAGE_RATE:
273 return "Get Message Rate";
274
275 case MessageType::SUPPORTED_IO_INTERFACES:
276 return "Supported IO Interfaces";
277
278 case MessageType::MESSAGE_RATE_RESPONSE:
279 return "Message Rate Response";
280
281 case MessageType::IMPORT_DATA:
282 return "Import Data To Device";
283
284 case MessageType::EXPORT_DATA:
285 return "Export Data From Device";
286
287 case MessageType::PLATFORM_STORAGE_DATA:
288 return "Platform Data Contents";
289
290 case MessageType::INPUT_DATA_WRAPPER:
291 return "Wrapped Input Data";
292
293 case MessageType::LBAND_FRAME:
294 return "L-band Frame Contents";
295
296 case MessageType::STA5635_COMMAND:
297 return "STA5635 Command";
298
299 case MessageType::STA5635_COMMAND_RESPONSE:
300 return "STA5635 Command Response";
301
302 case MessageType::STA5635_IQ_DATA:
303 return "STA5635 IQ Data";
304 }
305 return "Unrecognized Message";
306}
to_string()
|
Get a human-friendly string name for the specified Response.
- Parameters
-
val The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 474 of file defs.h.
474P1_CONSTEXPR_FUNC const char* to_string(Response val) {
475 switch (val) {
476 case Response::OK:
477 return "Ok";
478 case Response::UNSUPPORTED_CMD_VERSION:
479 return "Unsupported Command Version";
480 case Response::UNSUPPORTED_FEATURE:
481 return "Unsupported Feature";
482 case Response::VALUE_ERROR:
483 return "Value Error";
484 case Response::INSUFFICIENT_SPACE:
485 return "Insufficient Space";
486 case Response::EXECUTION_FAILURE:
487 return "Execution Failure";
488 case Response::INCONSISTENT_PAYLOAD_LENGTH:
489 return "Inconsistent Payload Length";
490 case Response::DATA_CORRUPTED:
491 return "Data Corrupted";
492 case Response::NO_DATA_STORED:
493 return "No Data Stored";
494 case Response::UNAVAILABLE:
495 return "Device Unavailable";
496 case Response::UNSUPPORTED_INTERFACE:
497 return "Unsupported Interface";
498 }
499 return "Unrecognized";
500}
to_string()
|
Get a human-friendly string name for the specified SolutionType.
- Parameters
-
type The desired message type.
- Returns
The corresponding string name.
Definition at line 549 of file defs.h.
549P1_CONSTEXPR_FUNC const char* to_string(SolutionType type) {
550 switch (type) {
551 case SolutionType::Invalid:
552 return "Invalid";
553
554 case SolutionType::AutonomousGPS:
555 return "Stand Alone GNSS";
556
557 case SolutionType::DGPS:
558 return "Differential GNSS";
559
560 case SolutionType::RTKFixed:
561 return "Fixed RTK GNSS";
562
563 case SolutionType::RTKFloat:
564 return "Real-valued Ambiguity RTK GNSS";
565
566 case SolutionType::Integrate:
567 return "Dead Reckoning";
568
569 case SolutionType::Visual:
570 return "Visual Navigation";
571
572 case SolutionType::PPP:
573 return "PPP GNSS";
574 }
575 return "Unrecognized Solution Type";
576}
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.