Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rs_device_base Struct Referenceabstract

#include <device.h>

Inheritance diagram for rs_device_base:
rs_device rsimpl::ds::ds_device rsimpl::iv_camera rsimpl::r200_camera rsimpl::zr300_camera rsimpl::f200_camera rsimpl::sr300_camera

Public Member Functions

 rs_device_base (std::shared_ptr< rsimpl::uvc::device > device, const rsimpl::static_device_info &info, rsimpl::calibration_validator validator=rsimpl::calibration_validator())
 
virtual ~rs_device_base ()
 
const rsimpl::stream_interfaceget_stream_interface (rs_stream stream) const override
 
const char * get_name () const override
 
const char * get_serial () const override
 
const char * get_firmware_version () const override
 
float get_depth_scale () const override
 
const char * get_camera_info (rs_camera_info info) const override
 
void enable_stream (rs_stream stream, int width, int height, rs_format format, int fps, rs_output_buffer_format output) override
 
void enable_stream_preset (rs_stream stream, rs_preset preset) override
 
void disable_stream (rs_stream stream) override
 
rs_motion_intrinsics get_motion_intrinsics () const override
 
rs_extrinsics get_motion_extrinsics_from (rs_stream from) const override
 
void enable_motion_tracking () override
 
void set_stream_callback (rs_stream stream, void(*on_frame)(rs_device *device, rs_frame_ref *frame, void *user), void *user) override
 
void set_stream_callback (rs_stream stream, rs_frame_callback *callback) override
 
void disable_motion_tracking () override
 
void set_motion_callback (rs_motion_callback *callback) override
 
void set_motion_callback (void(*on_event)(rs_device *device, rs_motion_data data, void *user), void *user) override
 
void set_timestamp_callback (void(*on_event)(rs_device *device, rs_timestamp_data data, void *user), void *user) override
 
void set_timestamp_callback (rs_timestamp_callback *callback) override
 
virtual void start (rs_source source) override
 
virtual void stop (rs_source source) override
 
virtual void start_fw_logger (char fw_log_op_code, int grab_rate_in_ms, std::timed_mutex &mutex) override
 
virtual void stop_fw_logger () override
 
bool is_capturing () const override
 
int is_motion_tracking_active () const override
 
void wait_all_streams () override
 
bool poll_all_streams () override
 
virtual bool supports (rs_capabilities capability) const override
 
virtual bool supports (rs_camera_info info_param) const override
 
virtual bool supports_option (rs_option option) const override
 
virtual void get_option_range (rs_option option, double &min, double &max, double &step, double &def) override
 
virtual void set_options (const rs_option options[], size_t count, const double values[]) override
 
virtual void get_options (const rs_option options[], size_t count, double values[]) override
 
virtual void on_before_start (const std::vector< rsimpl::subdevice_mode_selection > &selected_modes)=0
 
virtual rs_stream select_key_stream (const std::vector< rsimpl::subdevice_mode_selection > &selected_modes)=0
 
virtual std::vector< std::shared_ptr< rsimpl::frame_timestamp_reader > > create_frame_timestamp_readers () const =0
 
void release_frame (rs_frame_ref *ref) override
 
const char * get_usb_port_id () const override
 
rs_frame_refclone_frame (rs_frame_ref *frame) override
 
virtual void send_blob_to_device (rs_blob_type, void *, int)
 
const char * get_option_description (rs_option option) const override
 
- Public Member Functions inherited from rs_device
virtual ~rs_device ()
 
virtual const rs_stream_interfaceget_stream_interface (rs_stream stream) const =0
 
virtual const char * get_name () const =0
 
virtual const char * get_serial () const =0
 
virtual const char * get_firmware_version () const =0
 
virtual const char * get_camera_info (rs_camera_info) const =0
 
virtual float get_depth_scale () const =0
 
virtual void enable_stream (rs_stream stream, int width, int height, rs_format format, int fps, rs_output_buffer_format output)=0
 
virtual void enable_stream_preset (rs_stream stream, rs_preset preset)=0
 
virtual void disable_stream (rs_stream stream)=0
 
virtual void enable_motion_tracking ()=0
 
virtual void set_stream_callback (rs_stream stream, void(*on_frame)(rs_device *device, rs_frame_ref *frame, void *user), void *user)=0
 
virtual void set_stream_callback (rs_stream stream, rs_frame_callback *callback)=0
 
virtual void disable_motion_tracking ()=0
 
virtual rs_motion_intrinsics get_motion_intrinsics () const =0
 
virtual rs_extrinsics get_motion_extrinsics_from (rs_stream from) const =0
 
virtual void set_motion_callback (void(*on_event)(rs_device *device, rs_motion_data data, void *user), void *user)=0
 
virtual void set_motion_callback (rs_motion_callback *callback)=0
 
virtual void set_timestamp_callback (void(*on_event)(rs_device *device, rs_timestamp_data data, void *user), void *user)=0
 
virtual void set_timestamp_callback (rs_timestamp_callback *callback)=0
 
virtual void start (rs_source source)=0
 
virtual void stop (rs_source source)=0
 
virtual void start_fw_logger (char fw_log_op_code, int grab_rate_in_ms, std::timed_mutex &mutex)=0
 
virtual void stop_fw_logger ()=0
 
virtual bool is_capturing () const =0
 
virtual int is_motion_tracking_active () const =0
 
virtual void wait_all_streams ()=0
 
virtual bool poll_all_streams ()=0
 
virtual bool supports (rs_capabilities capability) const =0
 
virtual bool supports (rs_camera_info info_param) const =0
 
virtual bool supports_option (rs_option option) const =0
 
virtual void get_option_range (rs_option option, double &min, double &max, double &step, double &def)=0
 
virtual void set_options (const rs_option options[], size_t count, const double values[])=0
 
virtual void get_options (const rs_option options[], size_t count, double values[])=0
 
virtual const char * get_option_description (rs_option option) const =0
 
virtual void release_frame (rs_frame_ref *ref)=0
 
virtual rs_frame_refclone_frame (rs_frame_ref *frame)=0
 
virtual const char * get_usb_port_id () const =0
 

Static Public Member Functions

static void update_device_info (rsimpl::static_device_info &info)
 

Protected Member Functions

const rsimpl::uvc::device & get_device () const
 
rsimpl::uvc::device & get_device ()
 
virtual void start_video_streaming ()
 
virtual void stop_video_streaming ()
 
virtual void start_motion_tracking ()
 
virtual void stop_motion_tracking ()
 
virtual void disable_auto_option (int subdevice, rs_option auto_opt)
 
virtual void on_before_callback (rs_stream, rs_frame_ref *, std::shared_ptr< rsimpl::frame_archive >)
 

Protected Attributes

rsimpl::device_config config
 
bool motion_module_ready
 
std::atomic< bool > keep_fw_logger_alive
 
std::atomic< int > frames_drops_counter
 

Constructor & Destructor Documentation

◆ rs_device_base()

rs_device_base::rs_device_base ( std::shared_ptr< rsimpl::uvc::device >  device,
const rsimpl::static_device_info info,
rsimpl::calibration_validator  validator = rsimpl::calibration_validator() 
)

◆ ~rs_device_base()

virtual rs_device_base::~rs_device_base ( )
virtual

Member Function Documentation

◆ clone_frame()

rs_frame_ref * rs_device_base::clone_frame ( rs_frame_ref frame)
overridevirtual

Implements rs_device.

◆ create_frame_timestamp_readers()

virtual std::vector< std::shared_ptr< rsimpl::frame_timestamp_reader > > rs_device_base::create_frame_timestamp_readers ( ) const
pure virtual

◆ disable_auto_option()

virtual void rs_device_base::disable_auto_option ( int  subdevice,
rs_option  auto_opt 
)
protectedvirtual

◆ disable_motion_tracking()

void rs_device_base::disable_motion_tracking ( )
overridevirtual

Implements rs_device.

◆ disable_stream()

void rs_device_base::disable_stream ( rs_stream  stream)
overridevirtual

Implements rs_device.

◆ enable_motion_tracking()

void rs_device_base::enable_motion_tracking ( )
overridevirtual

Implements rs_device.

◆ enable_stream()

void rs_device_base::enable_stream ( rs_stream  stream,
int  width,
int  height,
rs_format  format,
int  fps,
rs_output_buffer_format  output 
)
overridevirtual

Implements rs_device.

◆ enable_stream_preset()

void rs_device_base::enable_stream_preset ( rs_stream  stream,
rs_preset  preset 
)
overridevirtual

Implements rs_device.

◆ get_camera_info()

const char * rs_device_base::get_camera_info ( rs_camera_info  info) const
overridevirtual

Implements rs_device.

◆ get_depth_scale()

float rs_device_base::get_depth_scale ( ) const
inlineoverridevirtual

Implements rs_device.

◆ get_device() [1/2]

rsimpl::uvc::device & rs_device_base::get_device ( )
inlineprotected

◆ get_device() [2/2]

const rsimpl::uvc::device & rs_device_base::get_device ( ) const
inlineprotected

◆ get_firmware_version()

const char * rs_device_base::get_firmware_version ( ) const
inlineoverridevirtual

Implements rs_device.

◆ get_motion_extrinsics_from()

rs_extrinsics rs_device_base::get_motion_extrinsics_from ( rs_stream  from) const
overridevirtual

Implements rs_device.

Reimplemented in rsimpl::zr300_camera.

◆ get_motion_intrinsics()

rs_motion_intrinsics rs_device_base::get_motion_intrinsics ( ) const
overridevirtual

Implements rs_device.

Reimplemented in rsimpl::zr300_camera.

◆ get_name()

const char * rs_device_base::get_name ( ) const
inlineoverridevirtual

Implements rs_device.

◆ get_option_description()

const char * rs_device_base::get_option_description ( rs_option  option) const
overridevirtual

Implements rs_device.

◆ get_option_range()

virtual void rs_device_base::get_option_range ( rs_option  option,
double &  min,
double &  max,
double &  step,
double &  def 
)
overridevirtual

Implements rs_device.

Reimplemented in rsimpl::ds::ds_device, and rsimpl::zr300_camera.

◆ get_options()

virtual void rs_device_base::get_options ( const rs_option  options[],
size_t  count,
double  values[] 
)
overridevirtual

◆ get_serial()

const char * rs_device_base::get_serial ( ) const
inlineoverridevirtual

Implements rs_device.

◆ get_stream_interface()

const rsimpl::stream_interface & rs_device_base::get_stream_interface ( rs_stream  stream) const
inlineoverridevirtual

Implements rs_device.

◆ get_usb_port_id()

const char * rs_device_base::get_usb_port_id ( ) const
overridevirtual

Implements rs_device.

◆ is_capturing()

bool rs_device_base::is_capturing ( ) const
inlineoverridevirtual

Implements rs_device.

◆ is_motion_tracking_active()

int rs_device_base::is_motion_tracking_active ( ) const
inlineoverridevirtual

Implements rs_device.

◆ on_before_callback()

virtual void rs_device_base::on_before_callback ( rs_stream  ,
rs_frame_ref ,
std::shared_ptr< rsimpl::frame_archive  
)
inlineprotectedvirtual

◆ on_before_start()

virtual void rs_device_base::on_before_start ( const std::vector< rsimpl::subdevice_mode_selection > &  selected_modes)
pure virtual

◆ poll_all_streams()

bool rs_device_base::poll_all_streams ( )
overridevirtual

Implements rs_device.

◆ release_frame()

void rs_device_base::release_frame ( rs_frame_ref ref)
overridevirtual

Implements rs_device.

◆ select_key_stream()

virtual rs_stream rs_device_base::select_key_stream ( const std::vector< rsimpl::subdevice_mode_selection > &  selected_modes)
pure virtual

◆ send_blob_to_device()

virtual void rs_device_base::send_blob_to_device ( rs_blob_type  ,
void *  ,
int   
)
inlinevirtual

Reimplemented in rsimpl::zr300_camera.

◆ set_motion_callback() [1/2]

void rs_device_base::set_motion_callback ( rs_motion_callback callback)
overridevirtual

Implements rs_device.

◆ set_motion_callback() [2/2]

void rs_device_base::set_motion_callback ( void(*)(rs_device *device, rs_motion_data data, void *user)  on_event,
void *  user 
)
overridevirtual

Implements rs_device.

◆ set_options()

virtual void rs_device_base::set_options ( const rs_option  options[],
size_t  count,
const double  values[] 
)
overridevirtual

◆ set_stream_callback() [1/2]

void rs_device_base::set_stream_callback ( rs_stream  stream,
rs_frame_callback callback 
)
overridevirtual

Implements rs_device.

◆ set_stream_callback() [2/2]

void rs_device_base::set_stream_callback ( rs_stream  stream,
void(*)(rs_device *device, rs_frame_ref *frame, void *user)  on_frame,
void *  user 
)
overridevirtual

Implements rs_device.

◆ set_timestamp_callback() [1/2]

void rs_device_base::set_timestamp_callback ( rs_timestamp_callback callback)
overridevirtual

Implements rs_device.

◆ set_timestamp_callback() [2/2]

void rs_device_base::set_timestamp_callback ( void(*)(rs_device *device, rs_timestamp_data data, void *user)  on_event,
void *  user 
)
overridevirtual

Implements rs_device.

◆ start()

virtual void rs_device_base::start ( rs_source  source)
overridevirtual

Implements rs_device.

Reimplemented in rsimpl::ds::ds_device, and rsimpl::zr300_camera.

◆ start_fw_logger()

virtual void rs_device_base::start_fw_logger ( char  fw_log_op_code,
int  grab_rate_in_ms,
std::timed_mutex &  mutex 
)
overridevirtual

◆ start_motion_tracking()

virtual void rs_device_base::start_motion_tracking ( )
protectedvirtual

Reimplemented in rsimpl::zr300_camera.

◆ start_video_streaming()

virtual void rs_device_base::start_video_streaming ( )
protectedvirtual

◆ stop()

virtual void rs_device_base::stop ( rs_source  source)
overridevirtual

Implements rs_device.

Reimplemented in rsimpl::ds::ds_device, and rsimpl::zr300_camera.

◆ stop_fw_logger()

virtual void rs_device_base::stop_fw_logger ( )
overridevirtual

◆ stop_motion_tracking()

virtual void rs_device_base::stop_motion_tracking ( )
protectedvirtual

Reimplemented in rsimpl::zr300_camera.

◆ stop_video_streaming()

virtual void rs_device_base::stop_video_streaming ( )
protectedvirtual

◆ supports() [1/2]

virtual bool rs_device_base::supports ( rs_camera_info  info_param) const
overridevirtual

Implements rs_device.

◆ supports() [2/2]

virtual bool rs_device_base::supports ( rs_capabilities  capability) const
overridevirtual

Implements rs_device.

◆ supports_option()

virtual bool rs_device_base::supports_option ( rs_option  option) const
overridevirtual

Implements rs_device.

Reimplemented in rsimpl::ds::ds_device, and rsimpl::zr300_camera.

◆ update_device_info()

static void rs_device_base::update_device_info ( rsimpl::static_device_info info)
static

◆ wait_all_streams()

void rs_device_base::wait_all_streams ( )
overridevirtual

Implements rs_device.

Member Data Documentation

◆ config

rsimpl::device_config rs_device_base::config
protected

◆ frames_drops_counter

std::atomic<int> rs_device_base::frames_drops_counter
protected

◆ keep_fw_logger_alive

std::atomic<bool> rs_device_base::keep_fw_logger_alive
protected

◆ motion_module_ready

bool rs_device_base::motion_module_ready
protected

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