Mech-Eye API
2.6.0
API reference documentation for Mech-Eye 3D Laser Profiler
Toggle main menu visibility
Loading...
Searching...
No Matches
ErrorStatus.h
1
#pragma once
2
#include <string>
3
#include <iostream>
4
5
namespace
mmind {
6
7
namespace
eye {
11
struct
ErrorStatus
12
{
16
enum
ErrorCode
{
17
MMIND_STATUS_SUCCESS
= 0,
18
MMIND_STATUS_INVALID_DEVICE
=
19
-1,
21
MMIND_STATUS_DEVICE_OFFLINE
= -2,
22
MMIND_STATUS_NO_SUPPORT_ERROR
=
23
-3,
26
MMIND_STATUS_OUT_OF_RANGE_ERROR
= -4,
28
MMIND_STATUS_PARAMETER_ERROR
=
29
-5,
31
MMIND_STATUS_NO_DATA_ERROR
=
32
-6,
33
MMIND_STATUS_INVALID_INPUT_ERROR
=
34
-7,
36
MMIND_STATUS_FILE_IO_ERROR
=
37
-8,
39
MMIND_STATUS_TIMEOUT_ERROR
=
40
-9,
42
MMIND_HANDEYE_CALIBRATION_EXECUTION_ERROR
=
43
-10,
44
MMIND_STATUS_REPLY_WITH_ERROR
= -11,
45
46
MMIND_STATUS_ACQUISITION_TRIGGER_WAIT
= -12,
47
48
MMIND_STATUS_DEVICE_BUSY
= -13,
50
MMIND_STATUS_INVALID_CALLBACKFUNC
= -14,
51
52
MMIND_STATUS_RESPONSE_PARSE_ERROR
= -15,
53
54
MMIND_STATUS_PROFILE_POST_PROCESS_ERROR
=
55
-16,
56
57
MMIND_STATUS_MESSAGE_CHANNEL_ERROR
= -17,
59
60
MMIND_STATUS_DUPLICATE_REGISTRATION
=
61
-18,
64
MMIND_STATUS_MESSAGE_CHANNEL_OCCUPPIED
=
65
-19,
67
MMIND_STATUS_BUFFER_FULL
= -20,
68
};
69
72
ErrorStatus
() =
default
;
73
77
ErrorStatus
(
ErrorCode
code,
const
std::string& message)
78
:
errorCode
(code),
errorDescription
(message)
79
{
80
}
81
85
bool
isOK
()
const
{
return
errorCode
==
MMIND_STATUS_SUCCESS
; }
86
90
ErrorCode
errorCode
{
MMIND_STATUS_SUCCESS
};
91
95
std::string
errorDescription
;
96
};
97
101
inline
void
showError(
const
mmind::eye::ErrorStatus
& status,
const
std::string& successMessage = {})
102
{
103
if
(status.
isOK
()) {
104
if
(!successMessage.empty())
105
std::cout << successMessage << std::endl;
106
return
;
107
}
108
std::cout <<
"Error Code : "
<< status.
errorCode
109
<<
", Error Description: "
<< status.
errorDescription
<< std::endl;
110
}
111
112
}
// namespace eye
113
114
}
// namespace mmind
mmind::eye::ErrorStatus
Describes the types of errors.
Definition
ErrorStatus.h:12
mmind::eye::ErrorStatus::ErrorCode
ErrorCode
Describes the error codes.
Definition
ErrorStatus.h:16
mmind::eye::ErrorStatus::MMIND_STATUS_SUCCESS
@ MMIND_STATUS_SUCCESS
Success.
Definition
ErrorStatus.h:17
mmind::eye::ErrorStatus::MMIND_STATUS_NO_DATA_ERROR
@ MMIND_STATUS_NO_DATA_ERROR
The image data is empty. Some error may have occurred on the device.
Definition
ErrorStatus.h:31
mmind::eye::ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE
@ MMIND_STATUS_DEVICE_OFFLINE
Device is offline. Network issue may be present.
Definition
ErrorStatus.h:21
mmind::eye::ErrorStatus::MMIND_STATUS_INVALID_CALLBACKFUNC
@ MMIND_STATUS_INVALID_CALLBACKFUNC
The registered callback function is invalid.
Definition
ErrorStatus.h:50
mmind::eye::ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR
@ MMIND_STATUS_TIMEOUT_ERROR
Definition
ErrorStatus.h:39
mmind::eye::ErrorStatus::MMIND_STATUS_INVALID_INPUT_ERROR
@ MMIND_STATUS_INVALID_INPUT_ERROR
Definition
ErrorStatus.h:33
mmind::eye::ErrorStatus::MMIND_STATUS_NO_SUPPORT_ERROR
@ MMIND_STATUS_NO_SUPPORT_ERROR
Definition
ErrorStatus.h:22
mmind::eye::ErrorStatus::MMIND_STATUS_DUPLICATE_REGISTRATION
@ MMIND_STATUS_DUPLICATE_REGISTRATION
Definition
ErrorStatus.h:60
mmind::eye::ErrorStatus::MMIND_STATUS_MESSAGE_CHANNEL_OCCUPPIED
@ MMIND_STATUS_MESSAGE_CHANNEL_OCCUPPIED
Definition
ErrorStatus.h:64
mmind::eye::ErrorStatus::MMIND_STATUS_DEVICE_BUSY
@ MMIND_STATUS_DEVICE_BUSY
Definition
ErrorStatus.h:48
mmind::eye::ErrorStatus::MMIND_STATUS_REPLY_WITH_ERROR
@ MMIND_STATUS_REPLY_WITH_ERROR
The reply from the device contains errors.
Definition
ErrorStatus.h:44
mmind::eye::ErrorStatus::MMIND_STATUS_OUT_OF_RANGE_ERROR
@ MMIND_STATUS_OUT_OF_RANGE_ERROR
Definition
ErrorStatus.h:26
mmind::eye::ErrorStatus::MMIND_HANDEYE_CALIBRATION_EXECUTION_ERROR
@ MMIND_HANDEYE_CALIBRATION_EXECUTION_ERROR
An error occurred while executing the hand-eye calibration.
Definition
ErrorStatus.h:42
mmind::eye::ErrorStatus::MMIND_STATUS_PROFILE_POST_PROCESS_ERROR
@ MMIND_STATUS_PROFILE_POST_PROCESS_ERROR
An error occurred while profile post process.
Definition
ErrorStatus.h:54
mmind::eye::ErrorStatus::MMIND_STATUS_INVALID_DEVICE
@ MMIND_STATUS_INVALID_DEVICE
Definition
ErrorStatus.h:18
mmind::eye::ErrorStatus::MMIND_STATUS_MESSAGE_CHANNEL_ERROR
@ MMIND_STATUS_MESSAGE_CHANNEL_ERROR
Definition
ErrorStatus.h:57
mmind::eye::ErrorStatus::MMIND_STATUS_ACQUISITION_TRIGGER_WAIT
@ MMIND_STATUS_ACQUISITION_TRIGGER_WAIT
Data acquisition has not been started.
Definition
ErrorStatus.h:46
mmind::eye::ErrorStatus::MMIND_STATUS_PARAMETER_ERROR
@ MMIND_STATUS_PARAMETER_ERROR
Definition
ErrorStatus.h:28
mmind::eye::ErrorStatus::MMIND_STATUS_BUFFER_FULL
@ MMIND_STATUS_BUFFER_FULL
The image buffer is full.
Definition
ErrorStatus.h:67
mmind::eye::ErrorStatus::MMIND_STATUS_FILE_IO_ERROR
@ MMIND_STATUS_FILE_IO_ERROR
Definition
ErrorStatus.h:36
mmind::eye::ErrorStatus::MMIND_STATUS_RESPONSE_PARSE_ERROR
@ MMIND_STATUS_RESPONSE_PARSE_ERROR
It is error to parse the response from device.
Definition
ErrorStatus.h:52
mmind::eye::ErrorStatus::ErrorStatus
ErrorStatus()=default
Default constructor.
mmind::eye::ErrorStatus::errorDescription
std::string errorDescription
Definition
ErrorStatus.h:95
mmind::eye::ErrorStatus::isOK
bool isOK() const
Returns true if the operation succeeded.
Definition
ErrorStatus.h:85
mmind::eye::ErrorStatus::errorCode
ErrorCode errorCode
Definition
ErrorStatus.h:90
mmind::eye::ErrorStatus::ErrorStatus
ErrorStatus(ErrorCode code, const std::string &message)
Constructor.
Definition
ErrorStatus.h:77
Generated by
1.17.0