Common Enumeration Definitions
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... | |
GNSS Constellation (System) Definitions Index
| P1_CONSTEXPR_FUNC const char * | to_string (SatelliteType type) |
|
Get a human-friendly string name for the specified SatelliteType (GNSS constellation). More... | |
| p1_ostream & | operator<< (p1_ostream &stream, SatelliteType type) |
|
SatelliteType stream operator. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (FrequencyBand type) |
|
Get a human-friendly string name for the specified FrequencyBand. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, FrequencyBand type) |
|
FrequencyBand stream operator. More... | |
Enumerations
Response
| strong |
Command response status indicators.
- Enumeration values
-
OK (= 0) UNSUPPORTED_CMD_VERSION A version specified in the command or subcommand could not be handled (= 1) 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) (= 2) 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) (= 3) INSUFFICIENT_SPACE The command would require adding too many elements to an internal storage (= 4) EXECUTION_FAILURE There was a runtime failure executing the command (= 5) 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 (= 6) DATA_CORRUPTED Requested data was corrupted and not available (= 7) NO_DATA_STORED The requested data isn't available (= 8) UNAVAILABLE The device is in a state where it can't process the command (= 9) UNSUPPORTED_INTERFACE An interface specified in the command is invalid, or unsupported on the target device (= 10)
Definition at line 406 of file defs.h.
407 OK = 0,
408 /**
409 * A version specified in the command or subcommand could not be handled.
410 * This could mean that the version was too new, or it was old and there was
411 * not a translation for it.
412 */
413 UNSUPPORTED_CMD_VERSION = 1,
414 /**
415 * The command interacts with a feature that is not present on the target
416 * device (e.g., Setting the baud rate on a device without a serial port).
417 */
418 UNSUPPORTED_FEATURE = 2,
419 /**
420 * One or more values in the command were not in acceptable ranges (e.g., An
421 * undefined enum value, or an invalid baud rate).
422 */
423 VALUE_ERROR = 3,
424 /**
425 * The command would require adding too many elements to an internal
426 * storage.
427 */
428 INSUFFICIENT_SPACE = 4,
429 /**
430 * There was a runtime failure executing the command.
431 */
432 EXECUTION_FAILURE = 5,
433 /**
434 * The header `payload_size_bytes` is in conflict with the size of the
435 * message based on its type and type specific length fields.
436 */
437 INCONSISTENT_PAYLOAD_LENGTH = 6,
438 /**
439 * Requested data was corrupted and not available.
440 */
441 DATA_CORRUPTED = 7,
442 /**
443 * The requested data isn't available.
444 */
445 NO_DATA_STORED = 8,
446 /**
447 * The device is in a state where it can't process the command.
448 */
449 UNAVAILABLE = 9,
450 /**
451 * An interface specified in the command is invalid, or unsupported on the
452 * target device.
453 */
454 UNSUPPORTED_INTERFACE = 10,
455};
SolutionType
| strong |
Navigation solution type definitions.
- Enumeration values
Definition at line 503 of file defs.h.
503enum class SolutionType : uint8_t {
504 /** Invalid, no position available. */
505 Invalid = 0,
506 /** Standalone GNSS fix, no GNSS corrections data used. */
507 AutonomousGPS = 1,
508 /**
509 * Differential GNSS pseudorange solution using a local RTK base station or
510 * SSR or SBAS corrections.
511 */
512 DGPS = 2,
513 /**
514 * GNSS RTK solution with fixed integer carrier phase ambiguities (one or more
515 * signals fixed).
516 */
517 RTKFixed = 4,
518 /** GNSS RTK solution with floating point carrier phase ambiguities. */
519 RTKFloat = 5,
520 /** Integrated position using dead reckoning. */
521 Integrate = 6,
522 /** Using vision measurements. */
523 Visual = 9,
524 /**
525 * GNSS precise point positioning (PPP) pseudorange/carrier phase solution.
526 */
527 PPP = 10,
529};
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 125 of file defs.h.
125P1_CONSTEXPR_FUNC const char* to_string(MessageType type) {
126 switch (type) {
127 case MessageType::INVALID:
128 return "Invalid";
129
130 // Navigation solution messages.
131 case MessageType::POSE:
132 return "Pose";
133
134 case MessageType::GNSS_INFO:
135 return "GNSS Info";
136
137 case MessageType::GNSS_SATELLITE:
138 return "GNSS Satellite";
139
140 case MessageType::POSE_AUX:
141 return "Pose Auxiliary";
142
143 case MessageType::CALIBRATION_STATUS:
144 return "Calibration Status";
145
146 case MessageType::RELATIVE_ENU_POSITION:
147 return "Relative ENU Position";
148
149 // Device status messages.
150 case MessageType::SYSTEM_STATUS:
151 return "System Status";
152
153 // Sensor measurement messages.
154 case MessageType::IMU_OUTPUT:
155 return "IMU Output";
156
158 return "Raw GNSS Heading Output";
159
160 case MessageType::RAW_IMU_OUTPUT:
161 return "Raw IMU Output";
162
163 case MessageType::DEPRECATED_HEADING_OUTPUT:
164 return "GNSS Heading Output";
165
166 case MessageType::IMU_INPUT:
167 return "IMU Input";
168
169 case MessageType::GNSS_ATTITUDE_OUTPUT:
170 return "GNSS Attitude Output";
171
172 case MessageType::RAW_GNSS_ATTITUDE_OUTPUT:
173 return "Raw GNSS Attitude Output";
174
176 return "Wheel Speed Measurement";
177
179 return "Vehicle Speed Measurement";
180
181 case MessageType::WHEEL_TICK_INPUT:
182 return "Wheel Tick Input";
183
184 case MessageType::VEHICLE_TICK_INPUT:
185 return "Vehicle Tick Input";
186
187 case MessageType::WHEEL_SPEED_INPUT:
188 return "Wheel Speed Input";
189
190 case MessageType::VEHICLE_SPEED_INPUT:
191 return "Vehicle Speed Input";
192
193 case MessageType::RAW_WHEEL_TICK_OUTPUT:
194 return "Raw Wheel Tick Output";
195
196 case MessageType::RAW_VEHICLE_TICK_OUTPUT:
197 return "Raw Vehicle Tick Output";
198
199 case MessageType::RAW_WHEEL_SPEED_OUTPUT:
200 return "Raw Wheel Speed Output";
201
202 case MessageType::RAW_VEHICLE_SPEED_OUTPUT:
203 return "Raw Vehicle Speed Output";
204
205 case MessageType::WHEEL_SPEED_OUTPUT:
206 return "Wheel Speed Output";
207
208 case MessageType::VEHICLE_SPEED_OUTPUT:
209 return "Vehicle Speed Output";
210
211 // ROS messages.
212 case MessageType::ROS_POSE:
213 return "ROS Pose";
214
215 case MessageType::ROS_GPS_FIX:
216 return "ROS GPSFix";
217
218 case MessageType::ROS_IMU:
219 return "ROS IMU";
220
221 // Command and control messages.
222 case MessageType::COMMAND_RESPONSE:
223 return "Command Response";
224
225 case MessageType::MESSAGE_REQUEST:
226 return "Message Transmission Request";
227
228 case MessageType::RESET_REQUEST:
229 return "Reset Request";
230
231 case MessageType::VERSION_INFO:
232 return "Version Information";
233
234 case MessageType::EVENT_NOTIFICATION:
235 return "Event Notification";
236
237 case MessageType::SHUTDOWN_REQUEST:
238 return "Shutdown Request";
239
240 case MessageType::STARTUP_REQUEST:
241 return "Startup Request";
242
243 case MessageType::DEVICE_ID:
244 return "Device ID Information";
245
246 case MessageType::FAULT_CONTROL:
247 return "Fault Control";
248
249 case MessageType::SET_CONFIG:
250 return "Set Configuration Parameter";
251
252 case MessageType::GET_CONFIG:
253 return "Get Configuration Parameter";
254
255 case MessageType::SAVE_CONFIG:
256 return "Save Configuration";
257
258 case MessageType::CONFIG_RESPONSE:
259 return "Configuration Parameter Value";
260
261 case MessageType::SET_MESSAGE_RATE:
262 return "Set Message Rate";
263
264 case MessageType::GET_MESSAGE_RATE:
265 return "Get Message Rate";
266
267 case MessageType::SUPPORTED_IO_INTERFACES:
268 return "Supported IO Interfaces";
269
270 case MessageType::MESSAGE_RATE_RESPONSE:
271 return "Message Rate Response";
272
273 case MessageType::IMPORT_DATA:
274 return "Import Data To Device";
275
276 case MessageType::EXPORT_DATA:
277 return "Export Data From Device";
278
279 case MessageType::PLATFORM_STORAGE_DATA:
280 return "Platform Data Contents";
281
282 case MessageType::INPUT_DATA_WRAPPER:
283 return "Wrapped Input Data";
284
285 case MessageType::LBAND_FRAME:
286 return "L-band Frame Contents";
287
288 case MessageType::STA5635_COMMAND:
289 return "STA5635 Command";
290
291 case MessageType::STA5635_COMMAND_RESPONSE:
292 return "STA5635 Command Response";
293
294 case MessageType::STA5635_IQ_DATA:
295 return "STA5635 IQ Data";
296 }
297 return "Unrecognized Message";
298}
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 464 of file defs.h.
464P1_CONSTEXPR_FUNC const char* to_string(Response val) {
465 switch (val) {
466 case Response::OK:
467 return "Ok";
468 case Response::UNSUPPORTED_CMD_VERSION:
469 return "Unsupported Command Version";
470 case Response::UNSUPPORTED_FEATURE:
471 return "Unsupported Feature";
472 case Response::VALUE_ERROR:
473 return "Value Error";
474 case Response::INSUFFICIENT_SPACE:
475 return "Insufficient Space";
476 case Response::EXECUTION_FAILURE:
477 return "Execution Failure";
478 case Response::INCONSISTENT_PAYLOAD_LENGTH:
479 return "Inconsistent Payload Length";
480 case Response::DATA_CORRUPTED:
481 return "Data Corrupted";
482 case Response::NO_DATA_STORED:
483 return "No Data Stored";
484 case Response::UNAVAILABLE:
485 return "Device Unavailable";
486 case Response::UNSUPPORTED_INTERFACE:
487 return "Unsupported Interface";
488 }
489 return "Unrecognized";
490}
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 539 of file defs.h.
539P1_CONSTEXPR_FUNC const char* to_string(SolutionType type) {
540 switch (type) {
541 case SolutionType::Invalid:
542 return "Invalid";
543
544 case SolutionType::AutonomousGPS:
545 return "Stand Alone GNSS";
546
547 case SolutionType::DGPS:
548 return "Differential GNSS";
549
550 case SolutionType::RTKFixed:
551 return "Fixed RTK GNSS";
552
553 case SolutionType::RTKFloat:
554 return "Real-valued Ambiguity RTK GNSS";
555
556 case SolutionType::Integrate:
557 return "Dead Reckoning";
558
559 case SolutionType::Visual:
560 return "Visual Navigation";
561
562 case SolutionType::PPP:
563 return "PPP GNSS";
564 }
565 return "Unrecognized Solution Type";
566}
GNSS Constellation (System) Definitions
operator<<
| inline |
SatelliteType stream operator.
Definition at line 91 of file signal_defs.h.
operator<<
| inline |
FrequencyBand stream operator.
Definition at line 271 of file signal_defs.h.
to_string
|
Get a human-friendly string name for the specified SatelliteType (GNSS constellation).
- Parameters
-
type The desired satellite type.
- Returns
The corresponding string name.
Definition at line 50 of file signal_defs.h.
50P1_CONSTEXPR_FUNC const char* to_string(SatelliteType type) {
51 switch (type) {
52 case SatelliteType::UNKNOWN:
53 return "Unknown";
54
55 case SatelliteType::GPS:
56 return "GPS";
57
58 case SatelliteType::GLONASS:
59 return "GLONASS";
60
61 case SatelliteType::LEO:
62 return "LEO";
63
64 case SatelliteType::GALILEO:
65 return "Galileo";
66
67 case SatelliteType::BEIDOU:
68 return "BeiDou";
69
70 case SatelliteType::QZSS:
71 return "QZSS";
72
73 case SatelliteType::MIXED:
74 return "Mixed";
75
76 case SatelliteType::SBAS:
77 return "SBAS";
78
79 case SatelliteType::IRNSS:
80 return "IRNSS";
81
82 default:
83 return "Invalid System";
84 }
85}
to_string
|
Get a human-friendly string name for the specified FrequencyBand.
- Parameters
-
type The desired frequency band.
- Returns
The corresponding string name.
Definition at line 245 of file signal_defs.h.
245P1_CONSTEXPR_FUNC const char* to_string(FrequencyBand type) {
246 switch (type) {
247 case FrequencyBand::UNKNOWN:
248 return "Unknown";
249
250 case FrequencyBand::L1:
251 return "L1";
252
253 case FrequencyBand::L2:
254 return "L2";
255
256 case FrequencyBand::L5:
257 return "L5";
258
259 case FrequencyBand::L6:
260 return "L6";
261
262 default:
263 return "Invalid Frequency Band";
264 }
265}
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.