Mech-Eye API 2.4.0
API reference documentation for Mech-Eye Industrial 3D Camera
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
mmind::eye::ErrorStatus Struct Reference

Describes 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_EXECUTION_ERROR , MMIND_STATUS_REPLY_WITH_ERROR = -11 ,
  MMIND_STATUS_ACQUISITION_TRIGGER_WAIT = -12 , MMIND_STATUS_DEVICE_BUSY = -13 , MMIND_STATUS_INVALID_CALLBACKFUNC = -14 , MMIND_STATUS_RESPONSE_PARSE_ERROR = -15 ,
  MMIND_STATUS_PROFILE_POST_PROCESS_ERROR , MMIND_STATUS_MESSAGE_CHANNEL_ERROR = -17 , MMIND_STATUS_DUPLICATE_REGISTRATION , MMIND_STATUS_MESSAGE_CHANNEL_OCCUPPIED
}
 Describes the error codes. More...
 

Public Member Functions

 ErrorStatus ()=default
 Default constructor.
 
 ErrorStatus (ErrorCode code, const std::string &message)
 Constructor.
 
bool isOK () const
 Returns true if the operation succeeded.
 

Public Attributes

ErrorCode errorCode {MMIND_STATUS_SUCCESS}
 
std::string errorDescription
 

Detailed Description

Describes the types of errors.

Definition at line 11 of file ErrorStatus.h.

Member Enumeration Documentation

◆ ErrorCode

Describes the error codes.

Enumerator
MMIND_STATUS_SUCCESS 

Success.

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_NO_SUPPORT_ERROR 

The operation is not supported. Possible reasons include: 1. The firmware version is inconsistent with the version of Mech-Eye API; 2. The device model does not provide the corresponding function.

MMIND_STATUS_OUT_OF_RANGE_ERROR 

The input device parameter value exceeds the settable value range.

MMIND_STATUS_PARAMETER_ERROR 

The input device parameter name does not exist, or the data type of the device parameter does not match the method.

MMIND_STATUS_NO_DATA_ERROR 

The image data is empty. Some error may have occurred on the device.

MMIND_STATUS_INVALID_INPUT_ERROR 

An invalid input not covered by other error types is provided, such as a nonexisting name of device user set.

MMIND_STATUS_FILE_IO_ERROR 

An error occurred when an operation related to reading or writing a file was executed, such as invalid filename and incorrect file type.

MMIND_STATUS_TIMEOUT_ERROR 

The set timeout period exceeded when an operation such as connecting to the device and retrieving data was performed.

MMIND_HANDEYE_CALIBRATION_EXECUTION_ERROR 

An error occurred while executing the hand-eye calibration.

MMIND_STATUS_REPLY_WITH_ERROR 

The reply from the device contains errors.

MMIND_STATUS_ACQUISITION_TRIGGER_WAIT 

Data acquisition has not been started.

MMIND_STATUS_DEVICE_BUSY 

The callback function was registered again before the ongoing data acquisition stopped.

MMIND_STATUS_INVALID_CALLBACKFUNC 

The registered callback function is invalid.

MMIND_STATUS_RESPONSE_PARSE_ERROR 

It is error to parse the response from device.

MMIND_STATUS_PROFILE_POST_PROCESS_ERROR 

An error occurred while profile post process.

MMIND_STATUS_MESSAGE_CHANNEL_ERROR 

An error occurred when the device was trying to establish/close the message channel.

MMIND_STATUS_DUPLICATE_REGISTRATION 

A callback function for the specific event has already been registered. The same event cannot have more than one callback function registered simultaneously.

MMIND_STATUS_MESSAGE_CHANNEL_OCCUPPIED 

Another client program has already established a message channel with the device.

Definition at line 16 of file ErrorStatus.h.

Constructor & Destructor Documentation

◆ ErrorStatus()

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

Constructor.

Definition at line 76 of file ErrorStatus.h.

Member Function Documentation

◆ isOK()

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

Returns true if the operation succeeded.

Definition at line 84 of file ErrorStatus.h.

Member Data Documentation

◆ errorCode

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

Error code.

Definition at line 89 of file ErrorStatus.h.

◆ errorDescription

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

Detailed error message.

Definition at line 94 of file ErrorStatus.h.


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