RealSense Cross Platform API
RealSense Cross-platform API
Loading...
Searching...
No Matches
rs2::option_value Class Reference

#include <rs_options.hpp>

Public Types

enum  invalid_t { invalid }

Public Member Functions

 option_value (rs2_option_value const *handle)
 option_value (rs2_option_value const *handle, std::shared_ptr< rs2_options_list > list, int index)
 option_value (option_value const &)=default
 option_value (option_value &&)=default
 option_value ()=default
 option_value (rs2_option option_id, invalid_t)
 option_value (rs2_option option_id, int64_t as_integer)
 option_value (rs2_option option_id, float as_float)
 option_value (rs2_option option_id, char const *as_string)
 option_value (rs2_option option_id, bool as_boolean)
option_value & operator= (option_value const &)=default
option_value & operator= (option_value &&)=default
rs2_option_value const * operator-> () const
 operator rs2_option_value const * () const
bool has_range () const
option_range range () const

Member Enumeration Documentation

◆ invalid_t

Enumerator
invalid 

Constructor & Destructor Documentation

◆ option_value() [1/10]

rs2::option_value::option_value ( rs2_option_value const * handle)
inlineexplicit

◆ option_value() [2/10]

rs2::option_value::option_value ( rs2_option_value const * handle,
std::shared_ptr< rs2_options_list > list,
int index )
inline

◆ option_value() [3/10]

rs2::option_value::option_value ( option_value const & )
default

◆ option_value() [4/10]

rs2::option_value::option_value ( option_value && )
default

◆ option_value() [5/10]

rs2::option_value::option_value ( )
default

◆ option_value() [6/10]

rs2::option_value::option_value ( rs2_option option_id,
invalid_t  )
inline

◆ option_value() [7/10]

rs2::option_value::option_value ( rs2_option option_id,
int64_t as_integer )
inline

◆ option_value() [8/10]

rs2::option_value::option_value ( rs2_option option_id,
float as_float )
inline

◆ option_value() [9/10]

rs2::option_value::option_value ( rs2_option option_id,
char const * as_string )
inline

◆ option_value() [10/10]

rs2::option_value::option_value ( rs2_option option_id,
bool as_boolean )
inline

Member Function Documentation

◆ has_range()

bool rs2::option_value::has_range ( ) const
inline
Returns
whether a range is available with this value

◆ operator rs2_option_value const *()

rs2::option_value::operator rs2_option_value const * ( ) const
inline

◆ operator->()

rs2_option_value const * rs2::option_value::operator-> ( ) const
inline

◆ operator=() [1/2]

option_value & rs2::option_value::operator= ( option_value && )
default

◆ operator=() [2/2]

option_value & rs2::option_value::operator= ( option_value const & )
default

◆ range()

option_range rs2::option_value::range ( ) const
inline

The range of values this option accepts. Throws if no range is available.


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