Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
librealsense::sensor_base Class Referenceabstract

#include <sensor.h>

Inheritance diagram for librealsense::sensor_base:
librealsense::sensor_interface librealsense::options_container librealsense::info_container librealsense::info_interface librealsense::options_interface librealsense::options_interface librealsense::extension_snapshot librealsense::info_interface librealsense::extension_snapshot librealsense::recordable< info_interface > librealsense::recordable< options_interface > librealsense::recordable< options_interface > librealsense::recordable< info_interface > librealsense::hid_sensor librealsense::software_sensor librealsense::tm2_sensor librealsense::uvc_sensor librealsense::ds5_color_sensor librealsense::l500_device::l500_depth_sensor librealsense::sr300_camera::sr300_color_sensor librealsense::sr300_camera::sr300_depth_sensor

Public Member Functions

 sensor_base (std::string name, device *device)
 
virtual stream_profiles init_stream_profiles ()=0
 
stream_profiles get_stream_profiles () const override
 
virtual stream_profiles get_active_streams () const override
 
notifications_callback_ptr get_notifications_callback () const override
 
void register_notifications_callback (notifications_callback_ptr callback) override
 
int register_before_streaming_changes_callback (std::function< void(bool)> callback) override
 
void unregister_before_start_callback (int token) override
 
std::shared_ptr< notifications_processorget_notifications_processor ()
 
virtual frame_callback_ptr get_frames_callback () const override
 
virtual void set_frames_callback (frame_callback_ptr callback) override
 
bool is_streaming () const override
 
virtual ~sensor_base ()
 
void register_metadata (rs2_frame_metadata_value metadata, std::shared_ptr< md_attribute_parser_base > metadata_parser) const
 
void register_on_open (on_open callback)
 
void register_on_before_frame_callback (on_before_frame_callback callback)
 
const device_interfaceget_device () override
 
void register_pixel_format (native_pixel_format pf)
 
void remove_pixel_format (native_pixel_format pf)
 
const std::string & get_info (rs2_camera_info info) const override
 
bool supports_info (rs2_camera_info info) const override
 
- Public Member Functions inherited from librealsense::sensor_interface
virtual void open (const stream_profiles &requests)=0
 
virtual void close ()=0
 
virtual void start (frame_callback_ptr callback)=0
 
virtual void stop ()=0
 
virtual ~sensor_interface ()=default
 
- Public Member Functions inherited from librealsense::info_interface
virtual ~info_interface ()=default
 
- Public Member Functions inherited from librealsense::recordable< info_interface >
virtual ~recordable ()=default
 
- 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::options_container
bool supports_option (rs2_option id) const override
 
optionget_option (rs2_option id) override
 
const optionget_option (rs2_option id) const override
 
void register_option (rs2_option id, std::shared_ptr< option > option)
 
void unregister_option (rs2_option id)
 
void create_snapshot (std::shared_ptr< options_interface > &snapshot) const override
 
void enable_recording (std::function< void(const options_interface &)> record_action) override
 
void update (std::shared_ptr< extension_snapshot > ext) override
 
- Public Member Functions inherited from librealsense::extension_snapshot
virtual ~extension_snapshot ()=default
 
- Public Member Functions inherited from librealsense::info_container
void register_info (rs2_camera_info info, const std::string &val)
 
void update_info (rs2_camera_info info, const std::string &val)
 
void create_snapshot (std::shared_ptr< info_interface > &snapshot) const override
 
void enable_recording (std::function< void(const info_interface &)> record_action) override
 
void update (std::shared_ptr< extension_snapshot > ext) override
 

Protected Member Functions

void raise_on_before_streaming_changes (bool streaming)
 
void set_active_streams (const stream_profiles &requests)
 
bool try_get_pf (const platform::stream_profile &p, native_pixel_format &result) const
 
void assign_stream (const std::shared_ptr< stream_interface > &stream, std::shared_ptr< stream_profile_interface > target) const
 
std::vector< request_mappingresolve_requests (stream_profiles requests)
 
std::shared_ptr< stream_profile_interfacemap_requests (std::shared_ptr< stream_profile_interface > request)
 

Protected Attributes

std::vector< platform::stream_profile_internal_config
 
std::atomic< bool > _is_streaming
 
std::atomic< bool > _is_opened
 
std::shared_ptr< notifications_processor_notifications_processor
 
on_before_frame_callback _on_before_frame_callback
 
on_open _on_open
 
std::shared_ptr< metadata_parser_map_metadata_parsers = nullptr
 
frame_source _source
 
device_owner
 
std::vector< platform::stream_profile_uvc_profiles
 

Constructor & Destructor Documentation

§ sensor_base()

librealsense::sensor_base::sensor_base ( std::string  name,
device device 
)
explicit

§ ~sensor_base()

virtual librealsense::sensor_base::~sensor_base ( )
inlinevirtual

Member Function Documentation

§ assign_stream()

void librealsense::sensor_base::assign_stream ( const std::shared_ptr< stream_interface > &  stream,
std::shared_ptr< stream_profile_interface target 
) const
protected

§ get_active_streams()

virtual stream_profiles librealsense::sensor_base::get_active_streams ( ) const
overridevirtual

§ get_device()

const device_interface& librealsense::sensor_base::get_device ( )
overridevirtual

§ get_frames_callback()

virtual frame_callback_ptr librealsense::sensor_base::get_frames_callback ( ) const
overridevirtual

§ get_info()

const std::string& librealsense::sensor_base::get_info ( rs2_camera_info  info) const
overridevirtual

Reimplemented from librealsense::info_container.

§ get_notifications_callback()

notifications_callback_ptr librealsense::sensor_base::get_notifications_callback ( ) const
overridevirtual

§ get_notifications_processor()

std::shared_ptr<notifications_processor> librealsense::sensor_base::get_notifications_processor ( )

§ get_stream_profiles()

stream_profiles librealsense::sensor_base::get_stream_profiles ( ) const
inlineoverridevirtual

§ init_stream_profiles()

virtual stream_profiles librealsense::sensor_base::init_stream_profiles ( )
pure virtual

§ is_streaming()

bool librealsense::sensor_base::is_streaming ( ) const
inlineoverridevirtual

§ map_requests()

std::shared_ptr<stream_profile_interface> librealsense::sensor_base::map_requests ( std::shared_ptr< stream_profile_interface request)
protected

§ raise_on_before_streaming_changes()

void librealsense::sensor_base::raise_on_before_streaming_changes ( bool  streaming)
protected

§ register_before_streaming_changes_callback()

int librealsense::sensor_base::register_before_streaming_changes_callback ( std::function< void(bool)>  callback)
overridevirtual

§ register_metadata()

void librealsense::sensor_base::register_metadata ( rs2_frame_metadata_value  metadata,
std::shared_ptr< md_attribute_parser_base metadata_parser 
) const

§ register_notifications_callback()

void librealsense::sensor_base::register_notifications_callback ( notifications_callback_ptr  callback)
overridevirtual

§ register_on_before_frame_callback()

void librealsense::sensor_base::register_on_before_frame_callback ( on_before_frame_callback  callback)
inline

§ register_on_open()

void librealsense::sensor_base::register_on_open ( on_open  callback)
inline

§ register_pixel_format()

void librealsense::sensor_base::register_pixel_format ( native_pixel_format  pf)

§ remove_pixel_format()

void librealsense::sensor_base::remove_pixel_format ( native_pixel_format  pf)

§ resolve_requests()

std::vector<request_mapping> librealsense::sensor_base::resolve_requests ( stream_profiles  requests)
protected

§ set_active_streams()

void librealsense::sensor_base::set_active_streams ( const stream_profiles requests)
protected

§ set_frames_callback()

virtual void librealsense::sensor_base::set_frames_callback ( frame_callback_ptr  callback)
overridevirtual

§ supports_info()

bool librealsense::sensor_base::supports_info ( rs2_camera_info  info) const
overridevirtual

Reimplemented from librealsense::info_container.

§ try_get_pf()

bool librealsense::sensor_base::try_get_pf ( const platform::stream_profile p,
native_pixel_format result 
) const
protected

§ unregister_before_start_callback()

void librealsense::sensor_base::unregister_before_start_callback ( int  token)
overridevirtual

Member Data Documentation

§ _internal_config

std::vector<platform::stream_profile> librealsense::sensor_base::_internal_config
protected

§ _is_opened

std::atomic<bool> librealsense::sensor_base::_is_opened
protected

§ _is_streaming

std::atomic<bool> librealsense::sensor_base::_is_streaming
protected

§ _metadata_parsers

std::shared_ptr<metadata_parser_map> librealsense::sensor_base::_metadata_parsers = nullptr
protected

§ _notifications_processor

std::shared_ptr<notifications_processor> librealsense::sensor_base::_notifications_processor
protected

§ _on_before_frame_callback

on_before_frame_callback librealsense::sensor_base::_on_before_frame_callback
protected

§ _on_open

on_open librealsense::sensor_base::_on_open
protected

§ _owner

device* librealsense::sensor_base::_owner
protected

§ _source

frame_source librealsense::sensor_base::_source
protected

§ _uvc_profiles

std::vector<platform::stream_profile> librealsense::sensor_base::_uvc_profiles
protected

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