Public Member Functions | Private Attributes | List of all members
librealsense::struct_field_option< T, R, W, U > Class Template Reference

#include <option.h>

Inheritance diagram for librealsense::struct_field_option< T, R, W, U >:
Inheritance graph
[legend]

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
 
bool is_enabled () const override
 
float query () const override
 
void set (float value) override
 
 struct_field_option (std::shared_ptr< struct_interface< T, R, W >> struct_interface, U T::*field, const option_range &range)
 
- Public Member Functions inherited from librealsense::option
virtual void create_snapshot (std::shared_ptr< option > &snapshot) const
 
virtual const char * get_value_description (float) const
 
virtual bool is_read_only () const
 
virtual ~option ()=default
 
- Public Member Functions inherited from librealsense::recordable< option >
virtual ~recordable ()=default
 

Private Attributes

U T::* _field
 
option_range _range
 
std::function< void(const option &)> _recording_function = [](const option&) {}
 
std::shared_ptr< struct_interface< T, R, W > > _struct_interface
 

Detailed Description

template<class T, class R, class W, class U>
class librealsense::struct_field_option< T, R, W, U >

Definition at line 440 of file option.h.

Constructor & Destructor Documentation

template<class T , class R , class W , class U >
librealsense::struct_field_option< T, R, W, U >::struct_field_option ( std::shared_ptr< struct_interface< T, R, W >>  struct_interface,
U T::*  field,
const option_range range 
)
inlineexplicit

Definition at line 458 of file option.h.

Member Function Documentation

template<class T , class R , class W , class U >
void librealsense::struct_field_option< T, R, W, U >::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 469 of file option.h.

template<class T , class R , class W , class U >
const char* librealsense::struct_field_option< T, R, W, U >::get_description ( ) const
inlineoverridevirtual

Implements librealsense::option.

Definition at line 464 of file option.h.

template<class T , class R , class W , class U >
option_range librealsense::struct_field_option< T, R, W, U >::get_range ( ) const
inlineoverridevirtual

Implements librealsense::option.

Definition at line 452 of file option.h.

template<class T , class R , class W , class U >
bool librealsense::struct_field_option< T, R, W, U >::is_enabled ( ) const
inlineoverridevirtual

Implements librealsense::option.

Definition at line 456 of file option.h.

template<class T , class R , class W , class U >
float librealsense::struct_field_option< T, R, W, U >::query ( void  ) const
inlineoverridevirtual

Implements librealsense::option.

Definition at line 448 of file option.h.

template<class T , class R , class W , class U >
void librealsense::struct_field_option< T, R, W, U >::set ( float  value)
inlineoverridevirtual

Implements librealsense::option.

Definition at line 443 of file option.h.

Member Data Documentation

template<class T , class R , class W , class U >
U T::* librealsense::struct_field_option< T, R, W, U >::_field
private

Definition at line 476 of file option.h.

template<class T , class R , class W , class U >
option_range librealsense::struct_field_option< T, R, W, U >::_range
private

Definition at line 475 of file option.h.

template<class T , class R , class W , class U >
std::function<void(const option&)> librealsense::struct_field_option< T, R, W, U >::_recording_function = [](const option&) {}
private

Definition at line 477 of file option.h.

template<class T , class R , class W , class U >
std::shared_ptr<struct_interface<T, R, W> > librealsense::struct_field_option< T, R, W, U >::_struct_interface
private

Definition at line 474 of file option.h.


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


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