librealsense::ptr_option< T > Class Template Reference

#include <option.h>

Inheritance diagram for librealsense::ptr_option< T >:

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

Private Attributes
T	_def
std::string	_desc
std::map< float, std::string >	_item_desc
T	_max
T	_min
std::function< void(float)>	_on_set
T	_step
T *	_value

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

Detailed Description

template<class T>
class librealsense::ptr_option< T >

Definition at line 161 of file option.h.

Constructor & Destructor Documentation

template<class T >

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

inline

Definition at line 164 of file option.h.

template<class T >

librealsense::ptr_option< T >::ptr_option ( T  min, T  max, T  step, T  def, T *  value, const std::string &  desc, const std::map< float, std::string > &  description_per_value  )

inline

Definition at line 175 of file option.h.

Member Function Documentation

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.

Definition at line 204 of file option.h.

template<class T >

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

inlineoverridevirtual

Implements librealsense::option.

Definition at line 206 of file option.h.

template<class T >

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

inlineoverridevirtual

Reimplemented from librealsense::option.

Definition at line 208 of file option.h.

template<class T >

bool librealsense::ptr_option< T >::is_enabled ( ) const

inlineoverridevirtual

Implements librealsense::option.

Definition at line 202 of file option.h.

template<class T >

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

inline

Definition at line 223 of file option.h.

template<class T >

float librealsense::ptr_option< T >::query ( void  ) const

inlineoverridevirtual

Implements librealsense::option.

Definition at line 197 of file option.h.

template<class T >

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

inlineoverridevirtual

Implements librealsense::option.

Definition at line 188 of file option.h.

template<class T >

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

inline

Definition at line 218 of file option.h.

Member Data Documentation

template<class T >

T librealsense::ptr_option< T >::_def

private

Definition at line 225 of file option.h.

template<class T >

std::string librealsense::ptr_option< T >::_desc

private

Definition at line 227 of file option.h.

template<class T >

std::map<float, std::string> librealsense::ptr_option< T >::_item_desc

private

Definition at line 228 of file option.h.

template<class T >

T librealsense::ptr_option< T >::_max

private

Definition at line 225 of file option.h.

template<class T >

T librealsense::ptr_option< T >::_min

private

Definition at line 225 of file option.h.

template<class T >

std::function<void(float)> librealsense::ptr_option< T >::_on_set

private

Definition at line 229 of file option.h.

template<class T >

T librealsense::ptr_option< T >::_step

private

Definition at line 225 of file option.h.

template<class T >

T* librealsense::ptr_option< T >::_value

private

Definition at line 226 of file option.h.

---

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

• option.h