The types of errors. More...

#include <ErrorStatus.h>

Public Types
enum	ErrorCode { MMIND_STATUS_SUCCESS = 0 , MMIND_STATUS_INVALID_DEVICE , MMIND_STATUS_DEVICE_OFFLINE = -2 , MMIND_STATUS_NO_SUPPORT_ERROR , MMIND_STATUS_OUT_OF_RANGE_ERROR = -4 , MMIND_STATUS_PARAMETER_ERROR , MMIND_STATUS_NO_DATA_ERROR , MMIND_STATUS_INVALID_INPUT_ERROR , MMIND_STATUS_FILE_IO_ERROR , MMIND_STATUS_TIMEOUT_ERROR , MMIND_HANDEYE_CALIBRATION_PATTERN_IMAGE_ERROR , MMIND_HANDEYE_CALIBRATION_POSES_INSUFFICIENT , MMIND_STATUS_ACQUISITION_TRIGGER_WAIT = -12 , MMIND_STATUS_DEVICE_BUSY = -13 , MMIND_STATUS_INVALID_CALLBACKFUNC = -14 }
	The error codes. More...

Public Member Functions
	ErrorStatus ()=default
	Default constructor.

	ErrorStatus (ErrorCode code, const std::string &message)
	Constructor with parameters.

bool	isOK () const
	Returns true if the operation succeeded.

Public Attributes
ErrorCode	errorCode {MMIND_STATUS_SUCCESS}

std::string	errorDescription

Detailed Description

The types of errors.

Definition at line 10 of file ErrorStatus.h.

Member Enumeration Documentation

◆ ErrorCode

enum mmind::eye::ErrorStatus::ErrorCode

The error codes.

Enumerator
MMIND_STATUS_SUCCESS	Success code.
MMIND_STATUS_INVALID_DEVICE	A Camera or Profiler object not connected to an actual device is used, or an IP address of a non-Mech-Eye device is input to the connect() method.
MMIND_STATUS_DEVICE_OFFLINE	Device is offline. Network issue may be present.
MMIND_STATUS_OUT_OF_RANGE_ERROR	The operation is not supported. Possible reasons include: 1. Firmware version is inconsistent with Mech-Eye API version; 2. Device model does not provide the corresponding function.
MMIND_STATUS_PARAMETER_ERROR	The input device parameter value exceeds the settable value range of the device parameter.
MMIND_STATUS_NO_DATA_ERROR	The input device parameter name does not exist, or the data type of the device parameter does not match the method.
MMIND_STATUS_INVALID_INPUT_ERROR	The image data is empty. Some error may have occurred on the device.
MMIND_STATUS_FILE_IO_ERROR	An invalid input not covered by other error types is provided, such as an nonexisting name of device parameter group.
MMIND_STATUS_TIMEOUT_ERROR	Error occurred when an operation related to reading or writing a file was executed, such as invalid filename and incorrect file type.
MMIND_HANDEYE_CALIBRATION_PATTERN_IMAGE_ERROR	Error occurred while processing the 2D image with feature detection results. The set timeout period exceeded when performing operations such as connecting to the device and retrieving data.
MMIND_HANDEYE_CALIBRATION_POSES_INSUFFICIENT	Error: insufficient calibration poses.
MMIND_STATUS_DEVICE_BUSY	Data acquisition has not been started.
MMIND_STATUS_INVALID_CALLBACKFUNC	The callback function registration is executed again before data acquisition is stopped.

Definition at line 15 of file ErrorStatus.h.

Constructor & Destructor Documentation

◆ ErrorStatus()

mmind::eye::ErrorStatus::ErrorStatus	(	ErrorCode	code,
		const std::string &	message
	)

inline

Constructor with parameters.

Definition at line 59 of file ErrorStatus.h.

Member Function Documentation

◆ isOK()

bool mmind::eye::ErrorStatus::isOK ( ) const

inline

Returns true if the operation succeeded.

Definition at line 67 of file ErrorStatus.h.

Member Data Documentation

◆ errorCode

ErrorCode mmind::eye::ErrorStatus::errorCode {MMIND_STATUS_SUCCESS}

Error code.

Definition at line 72 of file ErrorStatus.h.

◆ errorDescription

std::string mmind::eye::ErrorStatus::errorDescription

Detailed error message.

Definition at line 77 of file ErrorStatus.h.

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

include/ErrorStatus.h

Public Types

Public Member Functions

Public Attributes