Public Member Functions | Protected Attributes | List of all members
librealsense::options_container Class Reference

#include <options.h>

Inheritance diagram for librealsense::options_container:
Inheritance graph
[legend]

Public Member Functions

void create_snapshot (std::shared_ptr< options_interface > &snapshot) const override
 
void enable_recording (std::function< void(const options_interface &)> record_action) override
 
optionget_option (rs2_option id) override
 
const optionget_option (rs2_option id) const override
 
std::shared_ptr< optionget_option_handler (rs2_option id)
 
std::shared_ptr< optionget_option_handler (rs2_option id) const
 
virtual const char * get_option_name (rs2_option option) const override
 
std::vector< rs2_optionget_supported_options () const override
 
void register_option (rs2_option id, std::shared_ptr< option > option)
 
bool supports_option (rs2_option id) const override
 
void unregister_option (rs2_option id)
 
void update (std::shared_ptr< extension_snapshot > ext) override
 
- Public Member Functions inherited from librealsense::options_interface
virtual ~options_interface ()=default
 
- Public Member Functions inherited from librealsense::recordable< options_interface >
virtual ~recordable ()=default
 
- Public Member Functions inherited from librealsense::extension_snapshot
virtual ~extension_snapshot ()=default
 

Protected Attributes

std::map< rs2_option, std::shared_ptr< option > > _options
 
std::function< void(const options_interface &)> _recording_function = [](const options_interface&) {}
 

Detailed Description

Definition at line 48 of file options.h.

Member Function Documentation

void librealsense::options_container::create_snapshot ( std::shared_ptr< options_interface > &  snapshot) const
inlineoverridevirtual

Create a snapshot of the deriving extension. A snapshot of T is a reflection of the state and memory of T at the time of the call

Implements librealsense::recordable< options_interface >.

Definition at line 97 of file options.h.

void librealsense::options_container::enable_recording ( std::function< void(const options_interface &)>  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< options_interface >.

Definition at line 102 of file options.h.

option& librealsense::options_container::get_option ( rs2_option  id)
inlineoverridevirtual

Implements librealsense::options_interface.

Reimplemented in librealsense::record_sensor.

Definition at line 58 of file options.h.

const option& librealsense::options_container::get_option ( rs2_option  id) const
inlineoverridevirtual

Implements librealsense::options_interface.

Reimplemented in librealsense::record_sensor.

Definition at line 63 of file options.h.

std::shared_ptr<option> librealsense::options_container::get_option_handler ( rs2_option  id)
inline

Definition at line 75 of file options.h.

std::shared_ptr<option> librealsense::options_container::get_option_handler ( rs2_option  id) const
inline

Definition at line 80 of file options.h.

virtual const char* librealsense::options_container::get_option_name ( rs2_option  option) const
inlineoverridevirtual

Implements librealsense::options_interface.

Reimplemented in librealsense::zero_order.

Definition at line 119 of file options.h.

std::vector< rs2_option > librealsense::options_container::get_supported_options ( void  ) const
overridevirtual

Implements librealsense::options_interface.

Reimplemented in librealsense::l500_depth_sensor.

Definition at line 197 of file option.cpp.

void librealsense::options_container::register_option ( rs2_option  id,
std::shared_ptr< option option 
)
inline

Definition at line 86 of file options.h.

bool librealsense::options_container::supports_option ( rs2_option  id) const
inlineoverridevirtual

Implements librealsense::options_interface.

Reimplemented in librealsense::record_sensor.

Definition at line 51 of file options.h.

void librealsense::options_container::unregister_option ( rs2_option  id)
inline

Definition at line 92 of file options.h.

void librealsense::options_container::update ( std::shared_ptr< extension_snapshot ext)
inlineoverridevirtual

Implements librealsense::extension_snapshot.

Definition at line 107 of file options.h.

Member Data Documentation

std::map<rs2_option, std::shared_ptr<option> > librealsense::options_container::_options
protected

Definition at line 125 of file options.h.

std::function<void(const options_interface&)> librealsense::options_container::_recording_function = [](const options_interface&) {}
protected

Definition at line 126 of file options.h.


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


librealsense2
Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Mon May 3 2021 02:50:37