Public Member Functions | List of all members
librealsense::option Class Referenceabstract

#include <options.h>

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

Public Member Functions

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

Detailed Description

Definition at line 20 of file options.h.

Constructor & Destructor Documentation

virtual librealsense::option::~option ( )
virtualdefault

Member Function Documentation

void option::create_snapshot ( std::shared_ptr< option > &  snapshot) const
virtual

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< option >.

Reimplemented in librealsense::thermal_compensation.

Definition at line 30 of file option.cpp.

virtual const char* librealsense::option::get_description ( ) const
pure virtual

Implemented in librealsense::enable_motion_correction, librealsense::ivcam2::hw_sync_option, librealsense::ivcam2::freefall_option, librealsense::proxy_option, librealsense::polling_errors_disable, librealsense::struct_field_option< T, R, W, U >, librealsense::ivcam2::nest_option, librealsense::gl::dual_processing_block::bypass_option, librealsense::ivcam2::l500_temperature_options, librealsense::thermal_compensation, librealsense::uvc_xu_option< T >, librealsense::uvc_xu_option< uint8_t >, librealsense::auto_gain_limit_option, librealsense::auto_exposure_limit_option, librealsense::hdr_conditional_option, librealsense::uvc_pu_option, librealsense::hdr_option, librealsense::bool_option, librealsense::emitter_always_on_option, librealsense::motion_temperature_option, librealsense::advanced_mode_preset_option, librealsense::readonly_float_option, librealsense::asic_temperature_option, librealsense::float_option_with_description< T >, librealsense::float_option_with_description< rs2_l500_visual_preset >, librealsense::float_option_with_description< rs2_sensor_mode >, librealsense::alternating_emitter_option, librealsense::tracking_mode_option< flag, depends_on, invert >, librealsense::float_option, librealsense::composite_processing_block::bypass_option, librealsense::emitter_on_and_off_option, librealsense::sr3xx_camera::preset_option, librealsense::gain_option, librealsense::ptr_option< T >, librealsense::external_sync_mode, librealsense::exposure_mode_option, librealsense::exposure_option, librealsense::depth_scale_option, librealsense::auto_exposure_antiflicker_rate_option, librealsense::ir_reflectivity_option, librealsense::ivcam2::ac_trigger::reset_option, librealsense::auto_exposure_step_option, librealsense::max_usable_range_option, librealsense::option_description, librealsense::ivcam2::ac_trigger::enabler_option, librealsense::auto_exposure_mode_option, librealsense::l500_hw_options, librealsense::const_value_option, librealsense::enable_auto_exposure_option, librealsense::motion_module_temperature_option, librealsense::frame_queue_size, librealsense::asic_and_projector_temperature_options, and librealsense::global_time_option.

virtual option_range librealsense::option::get_range ( ) const
pure virtual
virtual const char* librealsense::option::get_value_description ( float  ) const
inlinevirtual
virtual bool librealsense::option::is_enabled ( ) const
pure virtual

Implemented in librealsense::enable_motion_correction, librealsense::ivcam2::freefall_option, librealsense::proxy_option, librealsense::polling_errors_disable, librealsense::ivcam2::nest_option, librealsense::struct_field_option< T, R, W, U >, librealsense::gl::dual_processing_block::bypass_option, librealsense::ivcam2::l500_temperature_options, librealsense::thermal_compensation, librealsense::uvc_xu_option< T >, librealsense::uvc_xu_option< uint8_t >, librealsense::auto_gain_limit_option, librealsense::auto_exposure_limit_option, librealsense::hdr_conditional_option, librealsense::hdr_option, librealsense::uvc_pu_option, librealsense::emitter_always_on_option, librealsense::advanced_mode_preset_option, librealsense::alternating_emitter_option, librealsense::tracking_mode_option< flag, depends_on, invert >, librealsense::float_option, librealsense::composite_processing_block::bypass_option, librealsense::emitter_on_and_off_option, librealsense::sr3xx_camera::preset_option, librealsense::gain_option, librealsense::ptr_option< T >, librealsense::external_sync_mode, librealsense::exposure_mode_option, librealsense::exposure_option, librealsense::depth_scale_option, librealsense::temperature_option, librealsense::auto_exposure_antiflicker_rate_option, librealsense::auto_exposure_step_option, librealsense::auto_exposure_mode_option, librealsense::l500_hw_options, librealsense::const_value_option, librealsense::enable_auto_exposure_option, librealsense::motion_module_temperature_option, librealsense::frame_queue_size, and librealsense::asic_and_projector_temperature_options.

virtual bool librealsense::option::is_read_only ( ) const
inlinevirtual
virtual float librealsense::option::query ( ) const
pure virtual

Implemented in librealsense::enable_motion_correction, librealsense::proxy_option, librealsense::polling_errors_disable, librealsense::ivcam2::nest_option, librealsense::gl::dual_processing_block::bypass_option, librealsense::struct_field_option< T, R, W, U >, librealsense::ivcam2::l500_temperature_options, librealsense::protected_xu_option< T >, librealsense::thermal_compensation, librealsense::auto_gain_limit_option, librealsense::uvc_xu_option< T >, librealsense::uvc_xu_option< uint8_t >, librealsense::auto_exposure_limit_option, librealsense::hdr_conditional_option, librealsense::hdr_option, librealsense::uvc_pu_option, librealsense::emitter_always_on_option, librealsense::advanced_mode_preset_option, librealsense::alternating_emitter_option, librealsense::float_option, librealsense::tracking_mode_option< flag, depends_on, invert >, librealsense::composite_processing_block::bypass_option, librealsense::emitter_on_and_off_option, librealsense::sr3xx_camera::preset_option, librealsense::gain_option, librealsense::external_sync_mode, librealsense::ptr_option< T >, librealsense::exposure_mode_option, librealsense::exposure_option, librealsense::depth_scale_option, librealsense::temperature_option, librealsense::auto_exposure_antiflicker_rate_option, librealsense::auto_exposure_step_option, librealsense::auto_exposure_mode_option, librealsense::const_value_option, librealsense::l500_hw_options, librealsense::enable_auto_exposure_option, librealsense::motion_module_temperature_option, librealsense::frame_queue_size, and librealsense::asic_and_projector_temperature_options.

virtual void librealsense::option::set ( float  value)
pure virtual

Implemented in librealsense::enable_motion_correction, librealsense::min_distance_option, librealsense::max_distance_option, librealsense::gated_option, librealsense::auto_disabling_control, librealsense::ivcam2::hw_sync_option, librealsense::ivcam2::freefall_option, librealsense::proxy_option, librealsense::polling_errors_disable, librealsense::struct_field_option< T, R, W, U >, librealsense::gl::dual_processing_block::bypass_option, librealsense::protected_xu_option< T >, librealsense::thermal_compensation, librealsense::auto_gain_limit_option, librealsense::auto_exposure_limit_option, librealsense::uvc_xu_option< T >, librealsense::uvc_xu_option< uint8_t >, librealsense::hdr_conditional_option, librealsense::hdr_option, librealsense::uvc_pu_option, librealsense::emitter_always_on_option, librealsense::advanced_mode_preset_option, librealsense::readonly_float_option, librealsense::alternating_emitter_option, librealsense::float_option, librealsense::tracking_mode_option< flag, depends_on, invert >, librealsense::emitter_on_and_off_option, librealsense::composite_processing_block::bypass_option, librealsense::gain_option, librealsense::sr3xx_camera::preset_option, librealsense::external_sync_mode, librealsense::exposure_mode_option, librealsense::ptr_option< T >, librealsense::exposure_option, librealsense::depth_scale_option, librealsense::l500_preset_option, librealsense::ir_reflectivity_option, librealsense::auto_exposure_antiflicker_rate_option, librealsense::sensor_mode_option, librealsense::ivcam2::ac_trigger::reset_option, librealsense::auto_exposure_step_option, librealsense::max_usable_range_option, librealsense::ivcam2::ac_trigger::enabler_option, librealsense::auto_exposure_mode_option, librealsense::l500_hw_options, librealsense::enable_auto_exposure_option, librealsense::digital_gain_option, librealsense::readonly_option, and librealsense::frame_queue_size.


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