rs2::options Class Reference

#include <rs_options.hpp>

Inheritance diagram for rs2::options:

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_value	get_option_value (rs2_option option_id) const
option_range	get_option_range (rs2_option option) const
void	set_option (rs2_option option, float value) const
void	set_option_value (option_value const &value) const
bool	is_option_read_only (rs2_option option) const
void	on_options_changed (std::function< void(const options_list &) > callback) const
std::vector< rs2_option >	get_supported_options ()
options_list	get_supported_option_values ()
options &	operator= (const options &other)
	options (const options &other)
virtual	~options ()=default

Protected Member Functions
	options (rs2_options *o=nullptr)
template<class T >
options &	operator= (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 float value

Parameters

[in]

option

option 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]

option

option 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]

option

option 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()

option_value rs2::options::get_option_value ( rs2_option  option_id ) const

inline

read option's value

Parameters

[in]

option_id

option id to be queried

Returns

option 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]	option	option id to be checked
[in]	val	value of the option

Returns

human-readable description of a specific value of an option or null if no special meaning

get_supported_option_values()

options_list rs2::options::get_supported_option_values ( )

inline

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]

option

option id to be checked

Returns

true if option is read-only

on_options_changed()

void rs2::options::on_options_changed ( std::function< void(const options_list &) >  callback ) const

inline

sets a callback in case an option in this options container value is updated

Parameters

[in]

callback

the callback function

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]	option	option id to be queried
[in]	value	new value for the option

set_option_value()

void rs2::options::set_option_value ( option_value const &  value ) const

inline

write new value to the option

Parameters

[in]	option	option id to be queried
[in]	value	option (id,type,is_valid,new value)

supports()

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

inline

check if particular option is supported

Parameters

[in]

option

option id to be checked

Returns

true if option is supported

---

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

• C:/jenkins_sys_rsbuild/workspace/LRS_doxygen_pipeline/source/include/librealsense2/hpp/rs_options.hpp