Main MRPT website > C++ reference for MRPT 1.5.6
xsresultvalue.h
Go to the documentation of this file.
1 /* +---------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | http://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file |
6  | See: http://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See details in http://www.mrpt.org/License |
8  +---------------------------------------------------------------------------+ */
9 #ifndef XSRESULTVALUE_H
10 #define XSRESULTVALUE_H
11 
12 #include "xstypesconfig.h"
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 //////////////////////////////////////////////////////////////////////////////////////////
19 /*! \addtogroup enums Global enumerations
20  @{
21 */
22 /*! \brief Xsens result values
23  \details These values are used to signal success or specific failures of functions
24  \sa XsResultValue_toString
25 */
27  // general OK
28  XRV_OK = 0 //!< 0: Operation was performed successfully
29 
30  // communication protocol
31  ,XRV_NOBUS = 1 //!< 1: No bus communication possible
32  ,XRV_BUSNOTREADY = 2 //!< 2: InitBus and/or SetBID are not issued
33  ,XRV_INVALIDPERIOD = 3 //!< 3: Period sent is invalid
34  ,XRV_INVALIDMSG = 4 //!< 4: The message is invalid or not implemented
35  ,XRV_INITBUSFAIL1 = 16 //!< 16: A slave did not respond to WaitForSetBID
36  ,XRV_INITBUSFAIL2 = 17 //!< 17: An incorrect answer received after WaitForSetBID
37  ,XRV_INITBUSFAIL3 = 18 //!< 18: After four bus-scans still undetected Motion Trackers
38  ,XRV_SETBIDFAIL1 = 20 //!< 20: No reply to SetBID message during SetBID procedure
39  ,XRV_SETBIDFAIL2 = 21 //!< 21: Other than SetBIDAck received
40  ,XRV_MEASUREMENTFAIL1 = 24 //!< 24: Timer overflow - period too short to collect all data from Motion Trackers
41  ,XRV_MEASUREMENTFAIL2 = 25 //!< 25: Motion Tracker responds with other than SlaveData message
42  ,XRV_MEASUREMENTFAIL3 = 26 //!< 26: Total bytes of data of Motion Trackers including sample counter exceeds 255 bytes
43  ,XRV_MEASUREMENTFAIL4 = 27 //!< 27: Timer overflows during measurement
44  ,XRV_MEASUREMENTFAIL5 = 28 //!< 28: Timer overflows during measurement
45  ,XRV_MEASUREMENTFAIL6 = 29 //!< 29: No correct response from Motion Tracker during measurement
46  ,XRV_TIMEROVERFLOW = 30 //!< 30: Timer overflows during measurement
47  ,XRV_BAUDRATEINVALID = 32 //!< 32: Baud rate does not comply with valid range
48  ,XRV_INVALIDPARAM = 33 //!< 33: An invalid parameter is supplied
49  ,XRV_MEASUREMENTFAIL7 = 35 //!< 35: TX PC Buffer is full
50  ,XRV_MEASUREMENTFAIL8 = 36 //!< 36: TX PC Buffer overflow, cannot fit full message
51  ,XRV_DEVICEERROR = 40 //!< 40: The device generated an error, try updating the firmware
52  ,XRV_DATAOVERFLOW = 41 //!< 41: The device generates more data than the bus communication can handle (baud rate may be too low)
53  ,XRV_BUFFEROVERFLOW = 42 //!< 42: The sample buffer of the device was full during a communication outage
54 
55  // CMT / XDA / XME / etc
56  ,XRV_ERROR = 256 //!< 256: A generic error occurred
57  ,XRV_NOTIMPLEMENTED = 257 //!< 257: Operation not implemented in this version (yet)
58  ,XRV_TIMEOUT = 258 //!< 258: A timeout occurred
59  ,XRV_TIMEOUTNODATA = 259 //!< 259: Operation aborted because of no data read
60  ,XRV_CHECKSUMFAULT = 260 //!< 260: Checksum fault occurred
61  ,XRV_OUTOFMEMORY = 261 //!< 261: No internal memory available
62  ,XRV_NOTFOUND = 262 //!< 262: The requested item was not found
63  ,XRV_UNEXPECTEDMSG = 263 //!< 263: Unexpected message received (e.g. no acknowledge message received)
64  ,XRV_INVALIDID = 264 //!< 264: Invalid id supplied
65  ,XRV_INVALIDOPERATION = 265 //!< 265: Operation is invalid at this point
66  ,XRV_INSUFFICIENTSPACE = 266 //!< 266: Insufficient buffer space available
67  ,XRV_INPUTCANNOTBEOPENED = 267 //!< 267: The specified i/o device can not be opened
68  ,XRV_OUTPUTCANNOTBEOPENED = 268 //!< 268: The specified i/o device can not be opened
69  ,XRV_ALREADYOPEN = 269 //!< 269: An I/O device is already opened with this object
70  ,XRV_ENDOFFILE = 270 //!< 270: End of file is reached
71  ,XRV_COULDNOTREADSETTINGS = 271 //!< 271: A required settings file could not be opened or is missing some data
72  ,XRV_NODATA = 272 //!< 272: No data is available
73  ,XRV_READONLY = 273 //!< 273: Tried to change a read-only value
74  ,XRV_NULLPTR = 274 //!< 274: Tried to supply a NULL value where it is not allowed
75  ,XRV_INSUFFICIENTDATA = 275 //!< 275: Insufficient data was supplied to a function
76  ,XRV_BUSY = 276 //!< 276: Busy processing, try again later
77  ,XRV_INVALIDINSTANCE = 277 //!< 277: Invalid instance called
78  ,XRV_DATACORRUPT = 278 //!< 278: A trusted data stream proves to contain corrupted data
79 
80  ,XRV_READINITFAILED = 279 //!< 279: Failure during read of settings
81  ,XRV_NOXMFOUND = 280 //!< 280: Could not find any MVN-compatible hardware
82  ,XRV_ONLYONEXMFOUND = 281 //!< 281: Found only one responding Xbus Master
83  ,XRV_MTCOUNTZERO = 282 //!< 282: No sensors found
84  ,XRV_MTLOCATIONINVALID = 283 //!< 283: One or more sensors are not where they were expected
85  ,XRV_INSUFFICIENTMTS = 284 //!< 284: Not enough sensors were found
86  ,XRV_INITFUSIONFAILED = 285 //!< 285: Failure during initialization of Fusion Engine
87  ,XRV_OTHER = 286 //!< 286: Something else was received than was requested
88 
89  ,XRV_NOFILEOPEN = 287 //!< 287: No file opened for reading/writing
90  ,XRV_NOPORTOPEN = 288 //!< 288: No serial port opened for reading/writing
91  ,XRV_NOFILEORPORTOPEN = 289 //!< 289: No file or serial port opened for reading/writing
92  ,XRV_PORTNOTFOUND = 290 //!< 290: A required port could not be found
93  ,XRV_INITPORTFAILED = 291 //!< 291: The low-level port handler failed to initialize
94  ,XRV_CALIBRATIONFAILED = 292 //!< 292: A calibration routine failed
95 
96  ,XRV_CONFIGCHECKFAIL = 293 //!< 293: The in-config check of the device failed
97  ,XRV_ALREADYDONE = 294 //!< 294: The operation is once only and has already been performed
98 
99  ,XRV_SYNC_SINGLE_SLAVE = 295 //!< 295: The single connected device is configured as a slave
100  ,XRV_SYNC_SECOND_MASTER = 296 //!< 296: More than one master was detected
101  ,XRV_SYNC_NO_SYNC = 297 //!< 297: A device was detected that was neither master nor slave
102  ,XRV_SYNC_NO_MASTER = 298 //!< 298: No master detected
103  ,XRV_SYNC_DATA_MISSING = 299 //!< 299: A device is not sending enough data
104 
105  ,XRV_VERSION_TOO_LOW = 300 //!< 300: The version of the object is too low for the requested operation
106  ,XRV_VERSION_PROBLEM = 301 //!< 301: The object has an unrecognized version, so it's not safe to perform the operation
107 
108  ,XRV_ABORTED = 302 //!< 302: The process was aborted by an external event, usually a user action or process termination
109  ,XRV_UNSUPPORTED = 303 //!< 303: The requested functionality is not supported by the device
110 
111  ,XRV_PACKETCOUNTERMISSED = 304 //!< 304: A packet counter value was missed
112 
113  ,XRV_MEASUREMENTFAILED = 305 //!< 305: An error occured while trying to put the device in measurement mode
114 };
115 /*! @} */
117 
118 
119 //! These enum values can be used to specify a device error (XRV_DEVICEERROR 0x28), i.e. a xbus message like [FA FF 42 05 28 XXXXXXXX CS]
121 {
130 };
132 
133 
134 
135 //////////////////////////////////////////////////////////////////////////////////////////
136 
137 /* \brief Retrieve a string corresponding to the given result code.
138 
139  This function uses the XsResultText list to return a string with the relevant result
140  code in a textual format. If the supplied result code is invalid the
141  "!!Invalid result code!!" string is returned.
142 */
143 XSTYPES_DLL_API const char* XsResultValue_toString(XsResultValue result);
144 
145 #ifdef __cplusplus
146 } // extern "C"
147 #endif
148 
149 #endif // file guard
2: InitBus and/or SetBID are not issued
Definition: xsresultvalue.h:32
284: Not enough sensors were found
Definition: xsresultvalue.h:85
XSTYPES_DLL_API const char * XsResultValue_toString(XsResultValue result)
30: Timer overflows during measurement
Definition: xsresultvalue.h:46
263: Unexpected message received (e.g. no acknowledge message received)
Definition: xsresultvalue.h:63
301: The object has an unrecognized version, so it's not safe to perform the operation ...
267: The specified i/o device can not be opened
Definition: xsresultvalue.h:67
277: Invalid instance called
Definition: xsresultvalue.h:77
4: The message is invalid or not implemented
Definition: xsresultvalue.h:34
299: A device is not sending enough data
295: The single connected device is configured as a slave
Definition: xsresultvalue.h:99
269: An I/O device is already opened with this object
Definition: xsresultvalue.h:69
27: Timer overflows during measurement
Definition: xsresultvalue.h:43
256: A generic error occurred
Definition: xsresultvalue.h:56
298: No master detected
294: The operation is once only and has already been performed
Definition: xsresultvalue.h:97
278: A trusted data stream proves to contain corrupted data
Definition: xsresultvalue.h:78
41: The device generates more data than the bus communication can handle (baud rate may be too low) ...
Definition: xsresultvalue.h:52
40: The device generated an error, try updating the firmware
Definition: xsresultvalue.h:51
0: Operation was performed successfully
Definition: xsresultvalue.h:28
286: Something else was received than was requested
Definition: xsresultvalue.h:87
26: Total bytes of data of Motion Trackers including sample counter exceeds 255 bytes ...
Definition: xsresultvalue.h:42
32: Baud rate does not comply with valid range
Definition: xsresultvalue.h:47
261: No internal memory available
Definition: xsresultvalue.h:61
272: No data is available
Definition: xsresultvalue.h:72
17: An incorrect answer received after WaitForSetBID
Definition: xsresultvalue.h:36
303: The requested functionality is not supported by the device
35: TX PC Buffer is full
Definition: xsresultvalue.h:49
XsResultValue
Xsens result values.
Definition: xsresultvalue.h:26
296: More than one master was detected
257: Operation not implemented in this version (yet)
Definition: xsresultvalue.h:57
21: Other than SetBIDAck received
Definition: xsresultvalue.h:39
16: A slave did not respond to WaitForSetBID
Definition: xsresultvalue.h:35
259: Operation aborted because of no data read
Definition: xsresultvalue.h:59
33: An invalid parameter is supplied
Definition: xsresultvalue.h:48
291: The low-level port handler failed to initialize
Definition: xsresultvalue.h:93
25: Motion Tracker responds with other than SlaveData message
Definition: xsresultvalue.h:41
3: Period sent is invalid
Definition: xsresultvalue.h:33
300: The version of the object is too low for the requested operation
304: A packet counter value was missed
42: The sample buffer of the device was full during a communication outage
Definition: xsresultvalue.h:53
36: TX PC Buffer overflow, cannot fit full message
Definition: xsresultvalue.h:50
266: Insufficient buffer space available
Definition: xsresultvalue.h:66
305: An error occured while trying to put the device in measurement mode
281: Found only one responding Xbus Master
Definition: xsresultvalue.h:82
264: Invalid id supplied
Definition: xsresultvalue.h:64
274: Tried to supply a NULL value where it is not allowed
Definition: xsresultvalue.h:74
#define XSTYPES_DLL_API
Definition: xstypesconfig.h:9
260: Checksum fault occurred
Definition: xsresultvalue.h:60
280: Could not find any MVN-compatible hardware
Definition: xsresultvalue.h:81
268: The specified i/o device can not be opened
Definition: xsresultvalue.h:68
258: A timeout occurred
Definition: xsresultvalue.h:58
273: Tried to change a read-only value
Definition: xsresultvalue.h:73
XsDeviceErrorType
These enum values can be used to specify a device error (XRV_DEVICEERROR 0x28), i.e. a xbus message like [FA FF 42 05 28 XXXXXXXX CS].
1: No bus communication possible
Definition: xsresultvalue.h:31
285: Failure during initialization of Fusion Engine
Definition: xsresultvalue.h:86
270: End of file is reached
Definition: xsresultvalue.h:70
265: Operation is invalid at this point
Definition: xsresultvalue.h:65
271: A required settings file could not be opened or is missing some data
Definition: xsresultvalue.h:71
262: The requested item was not found
Definition: xsresultvalue.h:62
297: A device was detected that was neither master nor slave
302: The process was aborted by an external event, usually a user action or process termination ...
276: Busy processing, try again later
Definition: xsresultvalue.h:76
18: After four bus-scans still undetected Motion Trackers
Definition: xsresultvalue.h:37
24: Timer overflow - period too short to collect all data from Motion Trackers
Definition: xsresultvalue.h:40
283: One or more sensors are not where they were expected
Definition: xsresultvalue.h:84
29: No correct response from Motion Tracker during measurement
Definition: xsresultvalue.h:45
288: No serial port opened for reading/writing
Definition: xsresultvalue.h:90
292: A calibration routine failed
Definition: xsresultvalue.h:94
287: No file opened for reading/writing
Definition: xsresultvalue.h:89
282: No sensors found
Definition: xsresultvalue.h:83
275: Insufficient data was supplied to a function
Definition: xsresultvalue.h:75
289: No file or serial port opened for reading/writing
Definition: xsresultvalue.h:91
290: A required port could not be found
Definition: xsresultvalue.h:92
20: No reply to SetBID message during SetBID procedure
Definition: xsresultvalue.h:38
279: Failure during read of settings
Definition: xsresultvalue.h:80
28: Timer overflows during measurement
Definition: xsresultvalue.h:44
293: The in-config check of the device failed
Definition: xsresultvalue.h:96



Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018