Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | Protected Member Functions | List of all members
rs2::options Class Reference

#include <rs_options.hpp>

Inheritance diagram for rs2::options:
rs2::processing_block rs2::sensor rs2::asynchronous_syncer rs2::filter rs2::calibrated_sensor rs2::color_sensor rs2::depth_sensor rs2::fisheye_sensor rs2::motion_sensor rs2::pose_sensor rs2::roi_sensor rs2::software_sensor rs2::wheel_odometer

Public Member Functions

bool supports (rs2_option option) const
 
const char * get_option_description (rs2_option option) const
 
const char * get_option_name (rs2_option option) const
 
const char * get_option_value_description (rs2_option option, float val) const
 
float get_option (rs2_option option) const
 
option_range get_option_range (rs2_option option) const
 
void set_option (rs2_option option, float value) const
 
bool is_option_read_only (rs2_option option) const
 
std::vector< rs2_optionget_supported_options ()
 
optionsoperator= (const options &other)
 
 options (const options &other)
 
virtual ~options ()=default
 

Protected Member Functions

 options (rs2_options *o=nullptr)
 
template<class T >
optionsoperator= (const T &dev)
 

Constructor & Destructor Documentation

◆ options() [1/2]

rs2::options::options ( const options other)
inline

◆ ~options()

virtual rs2::options::~options ( )
virtualdefault

◆ options() [2/2]

rs2::options::options ( rs2_options o = nullptr)
inlineexplicitprotected

Member Function Documentation

◆ get_option()

float rs2::options::get_option ( rs2_option  option) const
inline

read option's value

Parameters
[in]optionoption id to be queried
Returns
value of the option

◆ get_option_description()

const char* rs2::options::get_option_description ( rs2_option  option) const
inline

get option description

Parameters
[in]optionoption id to be checked
Returns
human-readable option description

◆ get_option_name()

const char* rs2::options::get_option_name ( rs2_option  option) const
inline

get option name

Parameters
[in]optionoption id to be checked
Returns
human-readable option name

◆ get_option_range()

option_range rs2::options::get_option_range ( rs2_option  option) const
inline

retrieve the available range of values of a supported option

Returns
option range containing minimum and maximum values, step and default value

◆ get_option_value_description()

const char* rs2::options::get_option_value_description ( rs2_option  option,
float  val 
) const
inline

get option value description (in case specific option value hold special meaning)

Parameters
[in]optionoption id to be checked
[in]valvalue of the option
Returns
human-readable description of a specific value of an option or null if no special meaning

◆ get_supported_options()

std::vector<rs2_option> rs2::options::get_supported_options ( )
inline

◆ is_option_read_only()

bool rs2::options::is_option_read_only ( rs2_option  option) const
inline

check if particular option is read-only

Parameters
[in]optionoption id to be checked
Returns
true if option is read-only

◆ operator=() [1/2]

options& rs2::options::operator= ( const options other)
inline

◆ operator=() [2/2]

template<class T >
options& rs2::options::operator= ( const T &  dev)
inlineprotected

◆ set_option()

void rs2::options::set_option ( rs2_option  option,
float  value 
) const
inline

write new value to the option

Parameters
[in]optionoption id to be queried
[in]valuenew value for the option

◆ supports()

bool rs2::options::supports ( rs2_option  option) const
inline

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

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