Mech-Eye API 2.3.3
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::api::ErrorStatus Struct Reference

This enumeration defines the types of errors. More...

#include <MechEyeDataType.h>

Public Types

enum  ErrorCode {
  MMIND_STATUS_SUCCESS = 0 , MMIND_STATUS_INVALID_DEVICE = -1 , MMIND_STATUS_DEVICE_OFFLINE , MMIND_STATUS_FIRMWARE_NOT_SUPPORTED ,
  MMIND_STATUS_PARAMETER_SET_ERROR = -4 , MMIND_STATUS_PARAMETER_GET_ERROR = -5 , MMIND_STATUS_CAPTURE_NO_FRAME = -6 , MMIND_STATUS_INVALID_INPUT_FRAME = -7 ,
  MMIND_STATUS_INVALID_INTRINSICS_PARAMETER = -8 , MMIND_HANDEYE_CALIBRATION_POSE_INVALID = -9 , MMIND_HANDEYE_CALIBRATION_PATTERN_IMAGE_ERROR , MMIND_HANDEYE_CALIBRATION_POSES_INSUFFICIENT
}
 

Public Member Functions

 ErrorStatus (ErrorCode code, const std::string &message)
 
bool isOK () const
 

Public Attributes

ErrorCode errorCode {MMIND_STATUS_SUCCESS}
 
std::string errorDescription
 

Detailed Description

This enumeration defines the types of errors.

Definition at line 44 of file MechEyeDataType.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
MMIND_STATUS_SUCCESS 

Success status.

MMIND_STATUS_INVALID_DEVICE 

Error invalid device.

MMIND_STATUS_DEVICE_OFFLINE 

Error offline device. Please check the status of the device.

MMIND_STATUS_FIRMWARE_NOT_SUPPORTED 

Error not supported camera firmware. Please use MechEye Viewer to upgrade.

MMIND_STATUS_PARAMETER_SET_ERROR 

Error setting parameter to device.

MMIND_STATUS_PARAMETER_GET_ERROR 

Error reading parameter from device.

MMIND_STATUS_CAPTURE_NO_FRAME 

Error no frame is captured.

MMIND_STATUS_INVALID_INPUT_FRAME 

Error invalid input frame.

MMIND_STATUS_INVALID_INTRINSICS_PARAMETER 

Error invalid intrinsics parameters.

MMIND_HANDEYE_CALIBRATION_POSE_INVALID 

Error invalid pose..

MMIND_HANDEYE_CALIBRATION_PATTERN_IMAGE_ERROR 

Error occurred while processing the 2D image with feature detection results.

MMIND_HANDEYE_CALIBRATION_POSES_INSUFFICIENT 

Error insufficient calibration poses.

Definition at line 46 of file MechEyeDataType.h.

Constructor & Destructor Documentation

◆ ErrorStatus()

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

Definition at line 65 of file MechEyeDataType.h.

Member Function Documentation

◆ isOK()

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

Definition at line 70 of file MechEyeDataType.h.

Member Data Documentation

◆ errorCode

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

Error code.

Definition at line 75 of file MechEyeDataType.h.

◆ errorDescription

std::string mmind::api::ErrorStatus::errorDescription

Detailed error message.

Definition at line 80 of file MechEyeDataType.h.


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