Public Member Functions | Protected Member Functions | Private Attributes | List of all members
rs2::options Class Reference

#include <rs_options.hpp>

Inheritance diagram for rs2::options:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

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

Private Attributes

rs2_options_options
 

Detailed Description

Definition at line 11 of file rs_options.hpp.

Constructor & Destructor Documentation

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

Definition at line 140 of file rs_options.hpp.

virtual rs2::options::~options ( )
virtualdefault
rs2::options::options ( rs2_options o = nullptr)
inlineexplicitprotected

Definition at line 144 of file rs_options.hpp.

Member Function Documentation

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

Definition at line 72 of file rs_options.hpp.

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

Definition at line 32 of file rs_options.hpp.

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

Definition at line 45 of file rs_options.hpp.

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

Definition at line 84 of file rs_options.hpp.

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

Definition at line 59 of file rs_options.hpp.

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

Definition at line 119 of file rs_options.hpp.

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

Definition at line 111 of file rs_options.hpp.

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

Definition at line 134 of file rs_options.hpp.

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

Definition at line 149 of file rs_options.hpp.

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

Definition at line 99 of file rs_options.hpp.

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

Definition at line 19 of file rs_options.hpp.

Member Data Documentation

rs2_options* rs2::options::_options
private

Definition at line 156 of file rs_options.hpp.


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


librealsense2
Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Sat Apr 3 2021 02:51:29