OrbbecSDK 2.10.6
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
ob::TypeHelper Class Reference

#include <TypeHelper.hpp>

Static Public Member Functions

static std::string convertOBFormatTypeToString (const OBFormat &type)
 Convert OBFormat to " string " type and then return.
static std::string convertOBFrameTypeToString (const OBFrameType &type)
 Convert OBFrameType to " string " type and then return.
static std::string convertOBStreamTypeToString (const OBStreamType &type)
 Convert OBStreamType to " string " type and then return.
static std::string convertOBSensorTypeToString (const OBSensorType &type)
 Convert OBSensorType to " string " type and then return.
static std::string convertOBIMUSampleRateTypeToString (const OBIMUSampleRate &type)
 Convert OBIMUSampleRate to " string " type and then return.
static float convertOBIMUSampleRateTypeToValue (const OBIMUSampleRate &type)
 Convert OBIMUSampleRate to its numeric frequency value in Hz.
static OBIMUSampleRate convertOBIMUSampleRateValueToType (float value)
 Convert a numeric IMU sample rate value in Hz to OBIMUSampleRate.
static std::string convertOBGyroFullScaleRangeTypeToString (const OBGyroFullScaleRange &type)
 Convert OBGyroFullScaleRange to " string " type and then return.
static std::string convertOBAccelFullScaleRangeTypeToString (const OBAccelFullScaleRange &type)
 Convert OBAccelFullScaleRange to " string " type and then return.
static std::string convertOBLiDARScanRateTypeToString (const OBLiDARScanRate &type)
 Convert OBLiDARScanRate to " string " type and then return.
static std::string convertOBFrameMetadataTypeToString (const OBFrameMetadataType &type)
 Convert OBFrameMetadataType to " string " type and then return.
static OBStreamType convertSensorTypeToStreamType (OBSensorType type)
 Convert OBSensorType to OBStreamType type and then return.
static OBSensorType convertStreamTypeToSensorType (OBStreamType type)
 Convert OBStreamType to OBSensorType and then return.
static OBFrameType convertStreamTypeToFrameType (OBStreamType type)
 Convert OBStreamType to OBFrameType and then return.
static OBStreamType convertFrameTypeToStreamType (OBFrameType type)
 Convert OBFrameType to OBStreamType and then return.
static OBSensorType convertFrameTypeToSensorType (OBFrameType type)
 Convert OBFrameType to OBSensorType and then return.
static bool isVideoSensorType (OBSensorType type)
 Check if the given sensor type is a video sensor.
static bool isVideoStreamType (OBStreamType type)
 Check if the given stream type is a video stream.

Detailed Description

Definition at line 14 of file TypeHelper.hpp.

Member Function Documentation

◆ convertOBFormatTypeToString()

std::string ob::TypeHelper::convertOBFormatTypeToString ( const OBFormat & type)
inlinestatic

Convert OBFormat to " string " type and then return.

Parameters
[in]typeOBFormat type.
Returns
OBFormat of "string" type.

Definition at line 23 of file TypeHelper.hpp.

◆ convertOBFrameTypeToString()

std::string ob::TypeHelper::convertOBFrameTypeToString ( const OBFrameType & type)
inlinestatic

Convert OBFrameType to " string " type and then return.

Parameters
[in]typeOBFrameType type.
Returns
OBFrameType of "string" type.

Definition at line 34 of file TypeHelper.hpp.

◆ convertOBStreamTypeToString()

std::string ob::TypeHelper::convertOBStreamTypeToString ( const OBStreamType & type)
inlinestatic

Convert OBStreamType to " string " type and then return.

Parameters
[in]typeOBStreamType type.
Returns
OBStreamType of "string" type.

Definition at line 45 of file TypeHelper.hpp.

◆ convertOBSensorTypeToString()

std::string ob::TypeHelper::convertOBSensorTypeToString ( const OBSensorType & type)
inlinestatic

Convert OBSensorType to " string " type and then return.

Parameters
[in]typeOBSensorType type.
Returns
OBSensorType of "string" type.

Definition at line 56 of file TypeHelper.hpp.

◆ convertOBIMUSampleRateTypeToString()

std::string ob::TypeHelper::convertOBIMUSampleRateTypeToString ( const OBIMUSampleRate & type)
inlinestatic

Convert OBIMUSampleRate to " string " type and then return.

Parameters
[in]typeOBIMUSampleRate type.
Returns
OBIMUSampleRate of "string" type.

Definition at line 67 of file TypeHelper.hpp.

◆ convertOBIMUSampleRateTypeToValue()

float ob::TypeHelper::convertOBIMUSampleRateTypeToValue ( const OBIMUSampleRate & type)
inlinestatic

Convert OBIMUSampleRate to its numeric frequency value in Hz.

Parameters
[in]typeOBIMUSampleRate type.
Returns
IMU sample rate value in Hz.

Definition at line 78 of file TypeHelper.hpp.

◆ convertOBIMUSampleRateValueToType()

OBIMUSampleRate ob::TypeHelper::convertOBIMUSampleRateValueToType ( float value)
inlinestatic

Convert a numeric IMU sample rate value in Hz to OBIMUSampleRate.

Parameters
[in]valueIMU sample rate value in Hz.
Returns
Matching OBIMUSampleRate.

Definition at line 89 of file TypeHelper.hpp.

◆ convertOBGyroFullScaleRangeTypeToString()

std::string ob::TypeHelper::convertOBGyroFullScaleRangeTypeToString ( const OBGyroFullScaleRange & type)
inlinestatic

Convert OBGyroFullScaleRange to " string " type and then return.

Parameters
[in]typeOBGyroFullScaleRange type.
Returns
OBGyroFullScaleRange of "string" type.

Definition at line 100 of file TypeHelper.hpp.

◆ convertOBAccelFullScaleRangeTypeToString()

std::string ob::TypeHelper::convertOBAccelFullScaleRangeTypeToString ( const OBAccelFullScaleRange & type)
inlinestatic

Convert OBAccelFullScaleRange to " string " type and then return.

Parameters
[in]typeOBAccelFullScaleRange type.
Returns
OBAccelFullScaleRange of "string" type.

Definition at line 111 of file TypeHelper.hpp.

◆ convertOBLiDARScanRateTypeToString()

std::string ob::TypeHelper::convertOBLiDARScanRateTypeToString ( const OBLiDARScanRate & type)
inlinestatic

Convert OBLiDARScanRate to " string " type and then return.

Parameters
[in]typeOBLiDARScanRate type.
Returns
OBLiDARScanRate of "string" type.

Definition at line 121 of file TypeHelper.hpp.

◆ convertOBFrameMetadataTypeToString()

std::string ob::TypeHelper::convertOBFrameMetadataTypeToString ( const OBFrameMetadataType & type)
inlinestatic

Convert OBFrameMetadataType to " string " type and then return.

Parameters
[in]typeOBFrameMetadataType type.
Returns
OBFrameMetadataType of "string" type.

Definition at line 132 of file TypeHelper.hpp.

◆ convertSensorTypeToStreamType()

OBStreamType ob::TypeHelper::convertSensorTypeToStreamType ( OBSensorType type)
inlinestatic

Convert OBSensorType to OBStreamType type and then return.

Parameters
[in]typeOBSensorType type.
Returns
OBStreamType type.

Definition at line 143 of file TypeHelper.hpp.

Referenced by ob::Config::disableStream(), ob::Config::enableStream(), ob::Config::enableVideoStream(), and ob::Config::enableVideoStream().

◆ convertStreamTypeToSensorType()

OBSensorType ob::TypeHelper::convertStreamTypeToSensorType ( OBStreamType type)
inlinestatic

Convert OBStreamType to OBSensorType and then return.

Parameters
[in]typeOBStreamType type.
Returns
OBSensorType type.

Definition at line 154 of file TypeHelper.hpp.

◆ convertStreamTypeToFrameType()

OBFrameType ob::TypeHelper::convertStreamTypeToFrameType ( OBStreamType type)
inlinestatic

Convert OBStreamType to OBFrameType and then return.

Parameters
[in]typeOBStreamType type.
Returns
OBFrameType type.

Definition at line 165 of file TypeHelper.hpp.

◆ convertFrameTypeToStreamType()

OBStreamType ob::TypeHelper::convertFrameTypeToStreamType ( OBFrameType type)
inlinestatic

Convert OBFrameType to OBStreamType and then return.

Parameters
[in]typeOBFrameType type.
Returns
OBStreamType type.

Definition at line 176 of file TypeHelper.hpp.

◆ convertFrameTypeToSensorType()

OBSensorType ob::TypeHelper::convertFrameTypeToSensorType ( OBFrameType type)
inlinestatic

Convert OBFrameType to OBSensorType and then return.

Parameters
[in]typeOBFrameType type.
Returns
OBSensorType type.

Definition at line 187 of file TypeHelper.hpp.

◆ isVideoSensorType()

bool ob::TypeHelper::isVideoSensorType ( OBSensorType type)
inlinestatic

Check if the given sensor type is a video sensor.

Video sensors are sensors that produce video frames.

The following sensor types are considered video sensors: OB_SENSOR_COLOR, OB_SENSOR_COLOR_LEFT, OB_SENSOR_COLOR_RIGHT, OB_SENSOR_DEPTH, OB_SENSOR_IR, OB_SENSOR_IR_LEFT, OB_SENSOR_IR_RIGHT, OB_SENSOR_CONFIDENCE,

Parameters
[in]typeThe sensor type
Returns
true/false

Definition at line 208 of file TypeHelper.hpp.

◆ isVideoStreamType()

bool ob::TypeHelper::isVideoStreamType ( OBStreamType type)
inlinestatic

Check if the given stream type is a video stream.

Video streams are streams that contain video frames.

The following stream types are considered video streams: OB_STREAM_VIDEO, OB_STREAM_DEPTH, OB_STREAM_COLOR, OB_STREAM_COLOR_LEFT, OB_STREAM_COLOR_RIGHT, OB_STREAM_IR, OB_STREAM_IR_LEFT, OB_STREAM_IR_RIGHT, OB_STREAM_CONFIDENCE,

Parameters
[in]typeThe stream type to check.
Returns
true if the given stream type is a video stream, false otherwise.

Definition at line 230 of file TypeHelper.hpp.

The documentation for this class was generated from the following file:
Generated on for OrbbecSDK by doxygen 1.18.0