OrbbecSDK 2.1.1
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Loading...
Searching...
No Matches
ob::Error Class Reference

#include <Error.hpp>

+ Inheritance diagram for ob::Error:

Public Member Functions

 ~Error () override
 Destroy the Error object.
 
const char * what () const noexcept override
 Returns the error message of the exception.
 
OBExceptionType getExceptionType () const noexcept
 Returns the exception type of the exception.
 
const char * getFunction () const noexcept
 Returns the name of the function where the exception occurred.
 
const char * getArgs () const noexcept
 Returns the arguments of the function where the exception occurred.
 
const char * getMessage () const noexcept
 Returns the error message of the exception.
 
const char * getName () const noexcept
 

Static Public Member Functions

static void handle (ob_error **error, bool throw_exception=true)
 A static function to handle the ob_error and throw an exception if needed.
 

Detailed Description

Definition at line 16 of file Error.hpp.

Constructor & Destructor Documentation

◆ ~Error()

ob::Error::~Error ( )
inlineoverride

Destroy the Error object.

Definition at line 53 of file Error.hpp.

Member Function Documentation

◆ handle()

static void ob::Error::handle ( ob_error ** error,
bool throw_exception = true )
inlinestatic

A static function to handle the ob_error and throw an exception if needed.

Parameters
errorThe ob_error pointer to be handled.
throw_exceptionA boolean value to indicate whether to throw an exception or not, the default value is true.

Definition at line 36 of file Error.hpp.

Referenced by ob::Align::Align(), ob::Frame::as(), ob::Frame::as(), ob::CoordinateTransformHelper::calibration2dTo2d(), ob::CoordinateTransformHelper::calibration2dTo3d(), ob::CoordinateTransformHelper::calibration3dTo2d(), ob::CoordinateTransformHelper::calibration3dTo3d(), ob::Config::Config(), ob::Context::Context(), ob::StreamProfileFactory::create(), ob::FilterFactory::createFilter(), ob::Context::createNetDevice(), ob::FilterFactory::createPrivateFilter(), ob::Sensor::createRecommendedFilters(), ob::Config::disableAllStream(), ob::Pipeline::disableFrameSync(), ob::Config::disableStream(), ob::Filter::enable(), ob::Config::enableAccelStream(), ob::Config::enableAllStream(), ob::Context::enableDeviceClockSync(), ob::Pipeline::enableFrameSync(), ob::Device::enableGlobalTimestamp(), ob::Config::enableGyroStream(), ob::Device::enableHeartbeat(), ob::Context::enableNetDeviceEnumeration(), ob::Config::enableStream(), ob::Config::enableStream(), ob::Config::enableVideoStream(), ob::Device::exportSettingsAsPresetJsonFile(), ob::FormatConvertFilter::FormatConvertFilter(), ob::Context::freeIdleMemory(), ob::StreamProfileList::getAccelStreamProfile(), ob::DeviceInfo::getAsicName(), ob::Device::getAvailableFrameInterleaveList(), ob::Device::getAvailablePresetList(), ob::Device::getBoolProperty(), ob::Device::getBoolPropertyRange(), ob::Device::getCalibrationCameraParamList(), ob::Pipeline::getCalibrationParam(), ob::CameraParamList::getCameraParam(), ob::Pipeline::getCameraParam(), ob::Pipeline::getCameraParamWithProfile(), ob::Pipeline::getConfig(), ob::Filter::getConfigSchema(), ob::Filter::getConfigValue(), ob::DeviceInfo::getConnectionType(), ob::DeviceList::getConnectionType(), ob::CameraParamList::getCount(), ob::DeviceFrameInterleaveList::getCount(), ob::DeviceList::getCount(), ob::DevicePresetList::getCount(), ob::OBDepthWorkModeList::getCount(), ob::SensorList::getCount(), ob::StreamProfileList::getCount(), ob::Device::getCurrentDepthModeName(), ob::Device::getCurrentDepthWorkMode(), ob::Device::getCurrentPresetName(), ob::Pipeline::getD2CDepthProfileList(), ob::Frame::getData(), ob::Frame::getDataSize(), ob::Device::getDepthWorkModeList(), ob::DeviceList::getDevice(), ob::Frame::getDevice(), ob::Pipeline::getDevice(), ob::DeviceList::getDeviceBySN(), ob::DeviceList::getDeviceByUid(), ob::Device::getDeviceInfo(), ob::DeviceInfo::getDeviceType(), ob::VideoStreamProfile::getDistortion(), ob::Config::getEnabledStreamProfileList(), ob::Device::getExtensionInfo(), ob::StreamProfile::getExtrinsicTo(), ob::FilterFactory::getFilterVendorSpecificCode(), ob::DeviceInfo::getFirmwareVersion(), ob::Device::getFloatProperty(), ob::Device::getFloatPropertyRange(), ob::Frame::getFormat(), ob::StreamProfile::getFormat(), ob::VideoStreamProfile::getFps(), ob::AccelStreamProfile::getFullScaleRange(), ob::GyroStreamProfile::getFullScaleRange(), ob::Frame::getGlobalTimeStampUs(), ob::StreamProfileList::getGyroStreamProfile(), ob::DeviceInfo::getHardwareVersion(), ob::VideoFrame::getHeight(), ob::VideoStreamProfile::getHeight(), ob::Frame::getIndex(), ob::Device::getIntProperty(), ob::Device::getIntPropertyRange(), ob::AccelStreamProfile::getIntrinsic(), ob::GyroStreamProfile::getIntrinsic(), ob::VideoStreamProfile::getIntrinsic(), ob::DeviceInfo::getIpAddress(), ob::DeviceList::getIpAddress(), ob::Frame::getMetadata(), ob::Frame::getMetadataSize(), ob::Frame::getMetadataValue(), ob::Device::getMultiDeviceSyncConfig(), ob::DeviceFrameInterleaveList::getName(), ob::DeviceInfo::getName(), ob::DeviceList::getName(), ob::DevicePresetList::getName(), ob::OBDepthWorkModeList::getOBDepthWorkMode(), ob::DeviceInfo::getPid(), ob::DeviceList::getPid(), ob::VideoFrame::getPixelAvailableBitSize(), ob::VideoFrame::getPixelType(), ob::StreamProfileList::getProfile(), ob::AccelStreamProfile::getSampleRate(), ob::GyroStreamProfile::getSampleRate(), ob::Device::getSensor(), ob::Frame::getSensor(), ob::SensorList::getSensor(), ob::SensorList::getSensor(), ob::Device::getSensorList(), ob::SensorList::getSensorType(), ob::DeviceInfo::getSerialNumber(), ob::DeviceList::getSerialNumber(), ob::Frame::getStreamProfile(), ob::Pipeline::getStreamProfileList(), ob::Sensor::getStreamProfileList(), ob::Device::getStructuredData(), ob::DeviceInfo::getSupportedMinSdkVersion(), ob::Device::getSupportedMultiDeviceSyncModeBitmap(), ob::Device::getSupportedProperty(), ob::Device::getSupportedPropertyCount(), ob::Frame::getSystemTimeStampUs(), ob::Device::getTimestampResetConfig(), ob::Frame::getTimeStampUs(), ob::Frame::getType(), ob::Sensor::getType(), ob::StreamProfile::getType(), ob::DeviceInfo::getUid(), ob::DeviceList::getUid(), ob::DepthFrame::getValueScale(), ob::DeviceInfo::getVid(), ob::DeviceList::getVid(), ob::StreamProfileList::getVideoStreamProfile(), ob::VideoFrame::getWidth(), ob::VideoStreamProfile::getWidth(), ob::DeviceFrameInterleaveList::hasFrameInterleave(), ob::Frame::hasMetadata(), ob::DevicePresetList::hasPreset(), ob::HdrMerge::HdrMerge(), ob::Filter::init(), ob::Filter::isEnabled(), ob::Device::isExtensionInfoExist(), ob::Device::isFrameInterleaveSupported(), ob::Device::isGlobalTimestampSupported(), ob::Device::isPropertySupported(), ob::Device::loadFrameInterleave(), ob::Device::loadPreset(), ob::Device::loadPresetFromJsonFile(), ob::Device::operator=(), ob::Sensor::operator=(), ob::StreamProfile::operator=(), ob::Pipeline::Pipeline(), ob::Pipeline::Pipeline(), ob::PointCloudFilter::PointCloudFilter(), ob::Filter::process(), ob::Filter::pushFrame(), ob::Context::queryDeviceList(), ob::Device::reboot(), ob::Filter::reset(), ob::Device::sendAndReceiveData(), ob::SequenceIdFilter::SequenceIdFilter(), ob::Config::setAlignMode(), ob::Align::setAlignToStreamProfile(), ob::Device::setBoolProperty(), ob::Filter::setCallBack(), ob::Filter::setConfigValue(), ob::Config::setDepthScaleRequire(), ob::Context::setDeviceChangedCallback(), ob::Device::setDeviceStateChangedCallback(), ob::Context::setExtensionsDirectory(), ob::Device::setFloatProperty(), ob::Config::setFrameAggregateOutputMode(), ob::Device::setIntProperty(), ob::Context::setLoggerSeverity(), ob::Context::setLoggerToCallback(), ob::Context::setLoggerToConsole(), ob::Context::setLoggerToFile(), ob::Device::setMultiDeviceSyncConfig(), ob::Device::setStructuredData(), ob::Device::setTimestampResetConfig(), ob::Context::setUvcBackendType(), ob::Pipeline::start(), ob::Pipeline::start(), ob::Sensor::start(), ob::Pipeline::stop(), ob::Sensor::stop(), ob::Device::switchDepthWorkMode(), ob::Device::switchDepthWorkMode(), ob::Sensor::switchProfile(), ob::Device::timerSyncWithHost(), ob::Device::timestampReset(), ob::CoordinateTransformHelper::transformation2dto2d(), ob::CoordinateTransformHelper::transformation2dto3d(), ob::CoordinateTransformHelper::transformation3dto2d(), ob::CoordinateTransformHelper::transformation3dto3d(), ob::CoordinateTransformHelper::transformationDepthFrameToColorCamera(), ob::CoordinateTransformHelper::transformationDepthToPointCloud(), ob::CoordinateTransformHelper::transformationDepthToRGBDPointCloud(), ob::CoordinateTransformHelper::transformationInitXYTables(), ob::Device::triggerCapture(), ob::Device::updateFirmware(), ob::Device::updateFirmwareFromData(), ob::Pipeline::waitForFrameset(), ob::CameraParamList::~CameraParamList(), ob::Config::~Config(), ob::Context::~Context(), ob::Device::~Device(), ob::DeviceFrameInterleaveList::~DeviceFrameInterleaveList(), ob::DeviceInfo::~DeviceInfo(), ob::DeviceList::~DeviceList(), ob::DevicePresetList::~DevicePresetList(), ob::Filter::~Filter(), ob::Frame::~Frame(), ob::OBDepthWorkModeList::~OBDepthWorkModeList(), ob::Pipeline::~Pipeline(), ob::Sensor::~Sensor(), ob::SensorList::~SensorList(), ob::StreamProfile::~StreamProfile(), and ob::StreamProfileList::~StreamProfileList().

◆ what()

const char * ob::Error::what ( ) const
inlineoverridenoexcept

Returns the error message of the exception.

Returns
const char* The error message.

Definition at line 65 of file Error.hpp.

◆ getExceptionType()

OBExceptionType ob::Error::getExceptionType ( ) const
inlinenoexcept

Returns the exception type of the exception.

Read the comments of the OBExceptionType enum in the libobsensor/h/ObTypes.h file for more information.

Returns
OBExceptionType The exception type.

Definition at line 75 of file Error.hpp.

◆ getFunction()

const char * ob::Error::getFunction ( ) const
inlinenoexcept

Returns the name of the function where the exception occurred.

Returns
const char* The function name.

Definition at line 84 of file Error.hpp.

◆ getArgs()

const char * ob::Error::getArgs ( ) const
inlinenoexcept

Returns the arguments of the function where the exception occurred.

Returns
const char* The arguments.

Definition at line 93 of file Error.hpp.

◆ getMessage()

const char * ob::Error::getMessage ( ) const
inlinenoexcept

Returns the error message of the exception.

It is recommended to use the what() function instead.

Returns
const char* The error message.

Definition at line 103 of file Error.hpp.

◆ getName()

const char * ob::Error::getName ( ) const
inlinenoexcept

Definition at line 109 of file Error.hpp.


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