Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | List of all members
librealsense::ptr_option< T > Class Template Reference

#include <option.h>

Inheritance diagram for librealsense::ptr_option< T >:
librealsense::option_base librealsense::option librealsense::recordable< option >

Public Member Functions

 ptr_option (T min, T max, T step, T def, T *value, const std::string &desc)
 
void set (float value) override
 
float query () const override
 
option_range get_range () const override
 
bool is_enabled () const override
 
void enable_recording (std::function< void(const option &)> record_action) override
 
const char * get_description () const override
 
const char * get_value_description (float val) const override
 
void set_description (float val, const std::string &desc)
 
void on_set (std::function< void(float)> on_set)
 
- Public Member Functions inherited from librealsense::option_base
 option_base (const option_range &opt_range)
 
bool is_valid (float value) const
 
- Public Member Functions inherited from librealsense::option
virtual bool is_read_only () const
 
virtual void create_snapshot (std::shared_ptr< option > &snapshot) const override
 
virtual ~option ()=default
 
- Public Member Functions inherited from librealsense::recordable< option >
virtual ~recordable ()=default
 

Additional Inherited Members

- Protected Attributes inherited from librealsense::option_base
const option_range _opt_range
 
std::function< void(const option &)> _recording_function = [](const option&) {}
 

Constructor & Destructor Documentation

◆ ptr_option()

template<class T >
librealsense::ptr_option< T >::ptr_option ( min,
max,
step,
def,
T *  value,
const std::string &  desc 
)
inline

Member Function Documentation

◆ enable_recording()

template<class T >
void librealsense::ptr_option< T >::enable_recording ( std::function< void(const option &)>  recording_function)
inlineoverridevirtual

Instruct the derived class to begin notifying on changes Derived class should call the recording_function with a reference of themselves

Reimplemented from librealsense::option_base.

◆ get_description()

template<class T >
const char* librealsense::ptr_option< T >::get_description ( ) const
inlineoverridevirtual

Implements librealsense::option.

◆ get_range()

template<class T >
option_range librealsense::ptr_option< T >::get_range ( ) const
inlineoverridevirtual

Reimplemented from librealsense::option_base.

◆ get_value_description()

template<class T >
const char* librealsense::ptr_option< T >::get_value_description ( float  val) const
inlineoverridevirtual

Reimplemented from librealsense::option.

◆ is_enabled()

template<class T >
bool librealsense::ptr_option< T >::is_enabled ( ) const
inlineoverridevirtual

Implements librealsense::option.

◆ on_set()

template<class T >
void librealsense::ptr_option< T >::on_set ( std::function< void(float)>  on_set)
inline

◆ query()

template<class T >
float librealsense::ptr_option< T >::query ( ) const
inlineoverridevirtual

Implements librealsense::option.

◆ set()

template<class T >
void librealsense::ptr_option< T >::set ( float  value)
inlineoverridevirtual

Implements librealsense::option.

◆ set_description()

template<class T >
void librealsense::ptr_option< T >::set_description ( float  val,
const std::string &  desc 
)
inline

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