librealsense::proxy_option Class Reference

#include <option.h>

Inheritance diagram for librealsense::proxy_option:

Public Member Functions
void	enable_recording (std::function< void(const option &)> record_action) override
const char *	get_description () const override
option_range	get_range () const override
const char *	get_value_description (float val) const override
bool	is_enabled () const override
bool	is_read_only () const override
	proxy_option (std::shared_ptr< option > proxy_option)
float	query () const override
virtual void	set (float value) override
Public Member Functions inherited from librealsense::option
virtual void	create_snapshot (std::shared_ptr< option > &snapshot) const
virtual	~option ()=default
Public Member Functions inherited from librealsense::recordable< option >
virtual	~recordable ()=default

Protected Attributes
std::shared_ptr< option >	_proxy
std::function< void(const option &)>	_recording_function = [](const option&) {}

Detailed Description

Wrapper for another option – forwards all API calls to the proxied option such that specific functionality can be easily overriden

Definition at line 540 of file option.h.

Constructor & Destructor Documentation

librealsense::proxy_option::proxy_option ( std::shared_ptr< option >  proxy_option )

inlineexplicit

Definition at line 543 of file option.h.

Member Function Documentation

void librealsense::proxy_option::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

Implements librealsense::recordable< option >.

Definition at line 579 of file option.h.

const char* librealsense::proxy_option::get_description ( ) const

inlineoverridevirtual

Implements librealsense::option.

Definition at line 551 of file option.h.

option_range librealsense::proxy_option::get_range ( ) const

inlineoverridevirtual

Implements librealsense::option.

Definition at line 564 of file option.h.

const char* librealsense::proxy_option::get_value_description ( float  val ) const

inlineoverridevirtual

Reimplemented from librealsense::option.

Definition at line 547 of file option.h.

bool librealsense::proxy_option::is_enabled ( ) const

inlineoverridevirtual

Implements librealsense::option.

Definition at line 569 of file option.h.

bool librealsense::proxy_option::is_read_only ( ) const

inlineoverridevirtual

Reimplemented from librealsense::option.

Definition at line 574 of file option.h.

float librealsense::proxy_option::query ( void  ) const

inlineoverridevirtual

Implements librealsense::option.

Definition at line 559 of file option.h.

virtual void librealsense::proxy_option::set ( float  value )

inlineoverridevirtual

Implements librealsense::option.

Reimplemented in librealsense::min_distance_option, librealsense::max_distance_option, librealsense::gated_option, and librealsense::auto_disabling_control.

Definition at line 555 of file option.h.

Member Data Documentation

std::shared_ptr<option> librealsense::proxy_option::_proxy

protected

Definition at line 584 of file option.h.

std::function<void(const option&)> librealsense::proxy_option::_recording_function = [](const option&) {}

protected

Definition at line 585 of file option.h.

---

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

• option.h