NVIDIA DeepStream SDK API Reference

9.2 Release
rs2::context Class Reference

Detailed Description

default librealsense context class includes realsense API version as provided by RS2_API_VERSION macro

Definition at line 96 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

Inheritance diagram for rs2::context:

Public Member Functions

 context ()
 
device_list query_devices () const
 create a static snapshot of all connected devices at the time of the call More...
 
device_list query_devices (int mask) const
 create a static snapshot of all connected devices at the time of the call More...
 
std::vector< sensor > query_all_sensors () const
 Generate a flat list of all available sensors from all RealSense devices. More...
 
device get_sensor_parent (const sensor &s) const
 
template<class T >
void set_devices_changed_callback (T callback)
 register devices changed callback More...
 
playback load_device (const std::string &file)
 Creates a device from a RealSense file. More...
 
void unload_device (const std::string &file)
 
void unload_tracking_module ()
 
 context (std::shared_ptr< rs2_context > ctx)
 
 operator std::shared_ptr< rs2_context > ()
 
 context ()
 
device_list query_devices () const
 create a static snapshot of all connected devices at the time of the call More...
 
device_list query_devices (int mask) const
 create a static snapshot of all connected devices at the time of the call More...
 
std::vector< sensor > query_all_sensors () const
 Generate a flat list of all available sensors from all RealSense devices. More...
 
device get_sensor_parent (const sensor &s) const
 
template<class T >
void set_devices_changed_callback (T callback)
 register devices changed callback More...
 
playback load_device (const std::string &file)
 Creates a device from a RealSense file. More...
 
void unload_device (const std::string &file)
 
void unload_tracking_module ()
 
 context (std::shared_ptr< rs2_context > ctx)
 
 operator std::shared_ptr< rs2_context > ()
 

Protected Attributes

std::shared_ptr< rs2_context > _context
 

Friends

class rs2::pipeline
 
class rs2::device_hub
 
class rs2::software_device
 

Constructor & Destructor Documentation

◆ context() [1/4]

◆ context() [2/4]

rs2::context::context ( std::shared_ptr< rs2_context >  ctx)
inline

◆ context() [3/4]

◆ context() [4/4]

rs2::context::context ( std::shared_ptr< rs2_context >  ctx)
inline

Member Function Documentation

◆ get_sensor_parent() [1/2]

◆ get_sensor_parent() [2/2]

◆ load_device() [1/2]

playback rs2::context::load_device ( const std::string &  file)
inline

Creates a device from a RealSense file.

On successful load, the device will be appended to the context and a devices_changed event triggered

Parameters
filePath to a RealSense File
Returns
A playback device matching the given file

Definition at line 184 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), rs2_context_add_device(), and rs2_delete_device().

◆ load_device() [2/2]

playback rs2::context::load_device ( const std::string &  file)
inline

Creates a device from a RealSense file.

On successful load, the device will be appended to the context and a devices_changed event triggered

Parameters
filePath to a RealSense File
Returns
A playback device matching the given file

Definition at line 184 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), rs2_context_add_device(), and rs2_delete_device().

◆ operator std::shared_ptr< rs2_context >() [1/2]

rs2::context::operator std::shared_ptr< rs2_context > ( )
inlineexplicit

◆ operator std::shared_ptr< rs2_context >() [2/2]

rs2::context::operator std::shared_ptr< rs2_context > ( )
inlineexplicit

◆ query_all_sensors() [1/2]

std::vector<sensor> rs2::context::query_all_sensors ( ) const
inline

Generate a flat list of all available sensors from all RealSense devices.

Returns
List of sensors

Definition at line 142 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References query_devices().

◆ query_all_sensors() [2/2]

std::vector<sensor> rs2::context::query_all_sensors ( ) const
inline

Generate a flat list of all available sensors from all RealSense devices.

Returns
List of sensors

Definition at line 142 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References query_devices().

◆ query_devices() [1/4]

device_list rs2::context::query_devices ( ) const
inline

create a static snapshot of all connected devices at the time of the call

Returns
the list of devices connected devices at the time of the call

Definition at line 112 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), rs2_delete_device_list(), and rs2_query_devices().

◆ query_devices() [2/4]

device_list rs2::context::query_devices ( ) const
inline

create a static snapshot of all connected devices at the time of the call

Returns
the list of devices connected devices at the time of the call

Definition at line 112 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), rs2_delete_device_list(), and rs2_query_devices().

Referenced by query_all_sensors().

◆ query_devices() [3/4]

device_list rs2::context::query_devices ( int  mask) const
inline

create a static snapshot of all connected devices at the time of the call

Returns
the list of devices connected devices at the time of the call

Definition at line 127 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), rs2_delete_device_list(), and rs2_query_devices_ex().

◆ query_devices() [4/4]

device_list rs2::context::query_devices ( int  mask) const
inline

create a static snapshot of all connected devices at the time of the call

Returns
the list of devices connected devices at the time of the call

Definition at line 127 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), rs2_delete_device_list(), and rs2_query_devices_ex().

◆ set_devices_changed_callback() [1/2]

template<class T >
void rs2::context::set_devices_changed_callback ( T  callback)
inline

register devices changed callback

Parameters
[in]callbackdevices changed callback

Definition at line 169 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), absl::move(), and rs2_set_devices_changed_callback_cpp().

◆ set_devices_changed_callback() [2/2]

template<class T >
void rs2::context::set_devices_changed_callback ( T  callback)
inline

register devices changed callback

Parameters
[in]callbackdevices changed callback

Definition at line 169 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_context.hpp.

References _context, rs2::error::handle(), absl::move(), and rs2_set_devices_changed_callback_cpp().

◆ unload_device() [1/2]

void rs2::context::unload_device ( const std::string &  file)
inline

◆ unload_device() [2/2]

void rs2::context::unload_device ( const std::string &  file)
inline

◆ unload_tracking_module() [1/2]

void rs2::context::unload_tracking_module ( )
inline

◆ unload_tracking_module() [2/2]

void rs2::context::unload_tracking_module ( )
inline

Friends And Related Function Documentation

◆ rs2::device_hub

◆ rs2::pipeline

◆ rs2::software_device

Field Documentation

◆ _context


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