rs2::software_device Class Reference

Detailed Description

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

Inheritance diagram for rs2::software_device:

Collaboration diagram for rs2::software_device:

Public Member Functions
	software_device (std::function< void(rs2_device *)> deleter=&rs2_delete_device)
	software_device (std::string name)
software_sensor	add_sensor (std::string name)
	Add software sensor with given name to the software device. More...
template<class T >
void	set_destruction_callback (T callback) const
	Register destruction callback. More...
void	add_to (context &ctx)
	Add software device to existing context. More...
void	register_info (rs2_camera_info info, const std::string &val)
	Add a new camera info value, like serial number. More...
void	update_info (rs2_camera_info info, const std::string &val)
	Update an existing camera info value, like serial number. More...
void	create_matcher (rs2_matchers matcher)
	Set the wanted matcher type that will be used by the syncer. More...
	software_device (std::function< void(rs2_device *)> deleter=&rs2_delete_device)
	software_device (std::string name)
software_sensor	add_sensor (std::string name)
	Add software sensor with given name to the software device. More...
template<class T >
void	set_destruction_callback (T callback) const
	Register destruction callback. More...
void	add_to (context &ctx)
	Add software device to existing context. More...
void	register_info (rs2_camera_info info, const std::string &val)
	Add a new camera info value, like serial number. More...
void	update_info (rs2_camera_info info, const std::string &val)
	Update an existing camera info value, like serial number. More...
void	create_matcher (rs2_matchers matcher)
	Set the wanted matcher type that will be used by the syncer. More...
std::vector< sensor >	query_sensors () const
	returns the list of adjacent devices, sharing the same physical parent composite device More...
std::vector< sensor >	query_sensors () const
	returns the list of adjacent devices, sharing the same physical parent composite device More...
template<class T >
T	first () const
template<class T >
T	first () const
bool	supports (rs2_camera_info info) const
	check if specific camera info is supported More...
bool	supports (rs2_camera_info info) const
	check if specific camera info is supported More...
const char *	get_info (rs2_camera_info info) const
	retrieve camera specific information, like versions of various internal components More...
const char *	get_info (rs2_camera_info info) const
	retrieve camera specific information, like versions of various internal components More...
void	hardware_reset ()
	send hardware reset request to the device More...
void	hardware_reset ()
	send hardware reset request to the device More...
	operator bool () const
	operator bool () const
const std::shared_ptr< rs2_device > &	get () const
const std::shared_ptr< rs2_device > &	get () const
template<class T >
bool	is () const
template<class T >
bool	is () const
template<class T >
T	as () const
template<class T >
T	as () const
	operator std::shared_ptr< rs2_device > ()
	operator std::shared_ptr< rs2_device > ()

Protected Attributes
std::shared_ptr< rs2_device >	_dev

Constructor & Destructor Documentation

software_device() [1/4]

rs2::software_device::software_device ( std::function< void(rs2_device *)>  deleter = &rs2_delete_device )

inline

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

References set_destruction_callback().

software_device() [2/4]

rs2::software_device::software_device ( std::string  name )

inline

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

References RS2_CAMERA_INFO_NAME, and update_info().

software_device() [3/4]

rs2::software_device::software_device ( std::function< void(rs2_device *)>  deleter = &rs2_delete_device )

inline

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

References set_destruction_callback().

software_device() [4/4]

rs2::software_device::software_device ( std::string  name )

inline

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

References RS2_CAMERA_INFO_NAME, and update_info().

Member Function Documentation

add_sensor() [1/2]

software_sensor rs2::software_device::add_sensor ( std::string  name )

inline

Add software sensor with given name to the software device.

Parameters

[in]

name

the name of the sensor

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

References rs2::device::_dev, rs2::error::handle(), rs2_delete_sensor(), and rs2_software_device_add_sensor().

add_sensor() [2/2]

software_sensor rs2::software_device::add_sensor ( std::string  name )

inline

Add software sensor with given name to the software device.

Parameters

[in]

name

the name of the sensor

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

References rs2::device::_dev, rs2::error::handle(), rs2_delete_sensor(), and rs2_software_device_add_sensor().

add_to() [1/2]

void rs2::software_device::add_to ( context &  ctx )

inline

Add software device to existing context.

Any future queries on the context will return this device. This operation cannot be undone (except for destroying the context)

Parameters

[in]

ctx

context to add the device to

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

References rs2::context::_context, rs2::device::_dev, rs2::error::handle(), and rs2_context_add_software_device().

add_to() [2/2]

void rs2::software_device::add_to ( context &  ctx )

inline

Add software device to existing context.

Any future queries on the context will return this device. This operation cannot be undone (except for destroying the context)

Parameters

[in]

ctx

context to add the device to

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

References rs2::context::_context, rs2::device::_dev, rs2::error::handle(), and rs2_context_add_software_device().

as() [1/2]

template<class T >

T rs2::device::as ( ) const

inlineinherited

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

as() [2/2]

template<class T >

T rs2::device::as ( ) const

inlineinherited

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

create_matcher() [1/2]

void rs2::software_device::create_matcher ( rs2_matchers  matcher )

inline

Set the wanted matcher type that will be used by the syncer.

Parameters

[in]

matcher

matcher type

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

References rs2::device::_dev, rs2::error::handle(), and rs2_software_device_create_matcher().

create_matcher() [2/2]

void rs2::software_device::create_matcher ( rs2_matchers  matcher )

inline

Set the wanted matcher type that will be used by the syncer.

Parameters

[in]

matcher

matcher type

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

References rs2::device::_dev, rs2::error::handle(), and rs2_software_device_create_matcher().

first() [1/2]

template<class T >

T rs2::device::first ( ) const

inlineinherited

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

References rs2::device::query_sensors().

first() [2/2]

template<class T >

T rs2::device::first ( ) const

inlineinherited

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

References rs2::device::query_sensors().

get() [1/2]

const std::shared_ptr<rs2_device>& rs2::device::get ( ) const

inlineinherited

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

References rs2::device::_dev.

Referenced by rs2::device_list::contains(), rs2::device_calibration::device_calibration(), rs2::recorder::recorder(), rs2::event_information::was_added(), and rs2::event_information::was_removed().

get() [2/2]

const std::shared_ptr<rs2_device>& rs2::device::get ( ) const

inlineinherited

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

References rs2::device::_dev.

get_info() [1/2]

const char* rs2::device::get_info ( rs2_camera_info  info ) const

inlineinherited

retrieve camera specific information, like versions of various internal components

Parameters

[in]

info

camera info type to retrieve

Returns

the requested camera info string, in a format specific to the device model

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

References rs2::device::_dev, rs2::error::handle(), and rs2_get_device_info().

get_info() [2/2]

const char* rs2::device::get_info ( rs2_camera_info  info ) const

inlineinherited

retrieve camera specific information, like versions of various internal components

Parameters

[in]

info

camera info type to retrieve

Returns

the requested camera info string, in a format specific to the device model

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

References rs2::device::_dev, rs2::error::handle(), and rs2_get_device_info().

hardware_reset() [1/2]

void rs2::device::hardware_reset ( )

inlineinherited

send hardware reset request to the device

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

References rs2::device::_dev, rs2::error::handle(), and rs2_hardware_reset().

hardware_reset() [2/2]

void rs2::device::hardware_reset ( )

inlineinherited

send hardware reset request to the device

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

References rs2::device::_dev, rs2::error::handle(), and rs2_hardware_reset().

is() [1/2]

template<class T >

bool rs2::device::is ( ) const

inlineinherited

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

is() [2/2]

template<class T >

bool rs2::device::is ( ) const

inlineinherited

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

operator bool() [1/2]

rs2::device::operator bool ( ) const

inlineinherited

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

References rs2::device::_dev.

operator bool() [2/2]

rs2::device::operator bool ( ) const

inlineinherited

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

References rs2::device::_dev.

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

rs2::device::operator std::shared_ptr< rs2_device > ( )

inlineexplicitinherited

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

References rs2::device::_dev.

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

rs2::device::operator std::shared_ptr< rs2_device > ( )

inlineexplicitinherited

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

References rs2::device::_dev.

query_sensors() [1/2]

std::vector<sensor> rs2::device::query_sensors ( ) const

inlineinherited

returns the list of adjacent devices, sharing the same physical parent composite device

Returns

the list of adjacent devices

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

References rs2::device::_dev, rs2::error::handle(), rs2_create_sensor(), rs2_delete_sensor(), rs2_delete_sensor_list(), rs2_get_sensors_count(), rs2_query_sensors(), and pydeepstreamdoc::tensor::TensorDoc::size.

query_sensors() [2/2]

std::vector<sensor> rs2::device::query_sensors ( ) const

inlineinherited

returns the list of adjacent devices, sharing the same physical parent composite device

Returns

the list of adjacent devices

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

References rs2::device::_dev, rs2::error::handle(), rs2_create_sensor(), rs2_delete_sensor(), rs2_delete_sensor_list(), rs2_get_sensors_count(), rs2_query_sensors(), and pydeepstreamdoc::tensor::TensorDoc::size.

Referenced by rs2::device::first().

register_info() [1/2]

void rs2::software_device::register_info ( rs2_camera_info  info, const std::string &  val  )

inline

Add a new camera info value, like serial number.

Parameters

[in]	info	Identifier of the camera info type
[in]	val	string value to set to this camera info type

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

References rs2::device::_dev, rs2::error::handle(), rs2_software_device_register_info(), and val.

register_info() [2/2]

void rs2::software_device::register_info ( rs2_camera_info  info, const std::string &  val  )

inline

Add a new camera info value, like serial number.

Parameters

[in]	info	Identifier of the camera info type
[in]	val	string value to set to this camera info type

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

References rs2::device::_dev, rs2::error::handle(), rs2_software_device_register_info(), and val.

set_destruction_callback() [1/2]

template<class T >

void rs2::software_device::set_destruction_callback ( T  callback ) const

inline

Register destruction callback.

Parameters

[in]

callback

destruction callback

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

References rs2::device::_dev, rs2::error::handle(), absl::move(), and rs2_software_device_set_destruction_callback_cpp().

set_destruction_callback() [2/2]

template<class T >

void rs2::software_device::set_destruction_callback ( T  callback ) const

inline

Register destruction callback.

Parameters

[in]

callback

destruction callback

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

References rs2::device::_dev, rs2::error::handle(), absl::move(), and rs2_software_device_set_destruction_callback_cpp().

Referenced by software_device().

supports() [1/2]

bool rs2::device::supports ( rs2_camera_info  info ) const

inlineinherited

check if specific camera info is supported

Parameters

[in]

info

the parameter to check for support

Returns

true if the parameter both exist and well-defined for the specific device

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

References rs2::device::_dev, rs2::error::handle(), and rs2_supports_device_info().

supports() [2/2]

bool rs2::device::supports ( rs2_camera_info  info ) const

inlineinherited

check if specific camera info is supported

Parameters

[in]

info

the parameter to check for support

Returns

true if the parameter both exist and well-defined for the specific device

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

References rs2::device::_dev, rs2::error::handle(), and rs2_supports_device_info().

update_info() [1/2]

void rs2::software_device::update_info ( rs2_camera_info  info, const std::string &  val  )

inline

Update an existing camera info value, like serial number.

Parameters

[in]	info	Identifier of the camera info type
[in]	val	string value to set to this camera info type

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

References rs2::device::_dev, rs2::error::handle(), rs2_software_device_update_info(), and val.

Referenced by software_device().

update_info() [2/2]

void rs2::software_device::update_info ( rs2_camera_info  info, const std::string &  val  )

inline

Update an existing camera info value, like serial number.

Parameters

[in]	info	Identifier of the camera info type
[in]	val	string value to set to this camera info type

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

References rs2::device::_dev, rs2::error::handle(), rs2_software_device_update_info(), and val.

Field Documentation

_dev

std::shared_ptr< rs2_device > rs2::device::_dev

protectedinherited

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

Referenced by add_sensor(), add_to(), rs400::advanced_mode::advanced_mode(), rs2::auto_calibrated_device::auto_calibrated_device(), rs2::calibration_change_device::calibration_change_device(), rs2::updatable::check_firmware_compatibility(), rs2::tm2::connect_controller(), rs2::updatable::create_flash_backup(), create_matcher(), rs2::firmware_logger::create_message(), rs2::firmware_logger::create_parsed_message(), rs2::playback::current_status(), rs2::debug_protocol::debug_protocol(), rs2::device_calibration::device_calibration(), rs2::tm2::disable_loopback(), rs2::tm2::disconnect_controller(), rs2::tm2::enable_loopback(), rs2::updatable::enter_update_state(), rs2::recorder::filename(), rs2::firmware_logger::firmware_logger(), rs2::device::get(), rs400::advanced_mode::get_ae_control(), rs400::advanced_mode::get_amp_factor(), rs2::auto_calibrated_device::get_calibration_table(), rs400::advanced_mode::get_census(), rs400::advanced_mode::get_color_control(), rs400::advanced_mode::get_color_correction(), rs400::advanced_mode::get_depth_control(), rs400::advanced_mode::get_depth_table(), rs2::playback::get_duration(), rs2::firmware_logger::get_firmware_log(), rs2::firmware_logger::get_flash_log(), rs400::advanced_mode::get_hdad(), rs2::device::get_info(), rs2::firmware_logger::get_number_of_fw_logs(), rs2::playback::get_position(), rs400::advanced_mode::get_rau_support_vector_control(), rs400::advanced_mode::get_rau_thresholds_control(), rs400::advanced_mode::get_rsm(), rs400::advanced_mode::get_slo_color_thresholds_control(), rs400::advanced_mode::get_slo_penalty_control(), rs2::device::hardware_reset(), rs2::firmware_logger::init_parser(), rs2::device_hub::is_connected(), rs400::advanced_mode::is_enabled(), rs2::tm2::is_loopback_enabled(), rs2::playback::is_real_time(), rs2::serializable_device::load_json(), rs2::device::operator bool(), rs2::device::operator std::shared_ptr< rs2_device >(), rs2::device::operator=(), rs2::firmware_logger::parse_log(), rs2::playback::pause(), rs2::recorder::pause(), rs2::playback::playback(), rs2::device::query_sensors(), rs2::recorder::recorder(), rs2::calibration_change_device::register_calibration_change_callback(), register_info(), rs2::calibrated_device::reset_to_factory_calibration(), rs2::playback::resume(), rs2::recorder::resume(), rs2::auto_calibrated_device::run_on_chip_calibration(), rs2::auto_calibrated_device::run_tare_calibration(), rs2::playback::seek(), rs2::debug_protocol::send_and_receive_raw_data(), rs2::serializable_device::serializable_device(), rs2::serializable_device::serialize_json(), rs400::advanced_mode::set_ae_control(), rs400::advanced_mode::set_amp_factor(), rs2::auto_calibrated_device::set_calibration_table(), rs400::advanced_mode::set_census(), rs400::advanced_mode::set_color_control(), rs400::advanced_mode::set_color_correction(), rs400::advanced_mode::set_depth_control(), rs400::advanced_mode::set_depth_table(), set_destruction_callback(), rs400::advanced_mode::set_hdad(), rs2::playback::set_playback_speed(), rs400::advanced_mode::set_rau_support_vector_control(), rs400::advanced_mode::set_rau_thresholds_control(), rs2::playback::set_real_time(), rs400::advanced_mode::set_rsm(), rs400::advanced_mode::set_slo_color_thresholds_control(), rs400::advanced_mode::set_slo_penalty_control(), rs2::playback::set_status_changed_callback(), rs2::playback::stop(), rs2::device::supports(), rs2::tm2::tm2(), rs400::advanced_mode::toggle_advanced_mode(), rs2::device_calibration::trigger_device_calibration(), rs2::updatable::updatable(), rs2::update_device::update(), rs2::update_device::update_device(), update_info(), rs2::updatable::update_unsigned(), and rs2::calibrated_device::write_calibration().

---

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

• sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_internal.hpp