NVIDIA DeepStream SDK API Reference
9.2 Release
Public Member Functions | Protected Attributes
rs2::max_usable_range_sensor Class Reference

Detailed Description

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

Inheritance diagram for rs2::max_usable_range_sensor:
Inheritance graph
[legend]
Collaboration diagram for rs2::max_usable_range_sensor:
Collaboration graph
[legend]

Public Member Functions

 max_usable_range_sensor (sensor s)
 
 operator bool () const
 
float get_max_usable_depth_range () const
 Retrieves the maximum range of the camera given the amount of ambient light in the scene. More...
 
 max_usable_range_sensor (sensor s)
 
 operator bool () const
 
float get_max_usable_depth_range () const
 Retrieves the maximum range of the camera given the amount of ambient light in the scene. More...
 
void open (const stream_profile &profile) const
 open sensor for exclusive access, by committing to a configuration More...
 
void open (const std::vector< stream_profile > &profiles) const
 open sensor for exclusive access, by committing to composite configuration, specifying one or more stream profiles this method should be used for interdependent streams, such as depth and infrared, that have to be configured together More...
 
void open (const stream_profile &profile) const
 open sensor for exclusive access, by committing to a configuration More...
 
void open (const std::vector< stream_profile > &profiles) const
 open sensor for exclusive access, by committing to composite configuration, specifying one or more stream profiles this method should be used for interdependent streams, such as depth and infrared, that have to be configured together More...
 
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...
 
bool supports (rs2_option option) const
 check if particular option is supported More...
 
bool supports (rs2_option option) const
 check if particular option is supported More...
 
bool supports (rs2_option option) const
 check if particular option is supported More...
 
bool supports (rs2_option option) const
 check if particular option is supported More...
 
bool supports (rs2_option option) const
 check if particular option 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 close () const
 close sensor for exclusive access this method should be used for releasing sensor resource More...
 
void close () const
 close sensor for exclusive access this method should be used for releasing sensor resource More...
 
template<class T >
void start (T callback) const
 Start passing frames into user provided callback. More...
 
template<class T >
void start (T callback) const
 Start passing frames into user provided callback. More...
 
void stop () const
 stop streaming More...
 
void stop () const
 stop streaming More...
 
template<class T >
void set_notifications_callback (T callback) const
 register notifications callback More...
 
template<class T >
void set_notifications_callback (T callback) const
 register notifications callback More...
 
std::vector< stream_profile > get_stream_profiles () const
 Retrieves the list of stream profiles supported by the sensor. More...
 
std::vector< stream_profile > get_stream_profiles () const
 Retrieves the list of stream profiles supported by the sensor. More...
 
std::vector< stream_profile > get_active_streams () const
 Retrieves the list of stream profiles currently streaming on the sensor. More...
 
std::vector< stream_profile > get_active_streams () const
 Retrieves the list of stream profiles currently streaming on the sensor. More...
 
std::vector< filter > get_recommended_filters () const
 get the recommended list of filters by the sensor More...
 
std::vector< filter > get_recommended_filters () const
 get the recommended list of filters by the sensor More...
 
const std::shared_ptr< rs2_sensor > & get () const
 
const std::shared_ptr< rs2_sensor > & 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_sensor > ()
 
 operator std::shared_ptr< rs2_sensor > ()
 
const char * get_option_description (rs2_option option) const
 get option description More...
 
const char * get_option_description (rs2_option option) const
 get option description More...
 
const char * get_option_name (rs2_option option) const
 get option name More...
 
const char * get_option_name (rs2_option option) const
 get option name More...
 
const char * get_option_value_description (rs2_option option, float val) const
 get option value description (in case specific option value hold special meaning) More...
 
const char * get_option_value_description (rs2_option option, float val) const
 get option value description (in case specific option value hold special meaning) More...
 
float get_option (rs2_option option) const
 read option's value More...
 
float get_option (rs2_option option) const
 read option's value More...
 
option_range get_option_range (rs2_option option) const
 retrieve the available range of values of a supported option More...
 
option_range get_option_range (rs2_option option) const
 retrieve the available range of values of a supported option More...
 
void set_option (rs2_option option, float value) const
 write new value to the option More...
 
void set_option (rs2_option option, float value) const
 write new value to the option More...
 
bool is_option_read_only (rs2_option option) const
 check if particular option is read-only More...
 
bool is_option_read_only (rs2_option option) const
 check if particular option is read-only More...
 
std::vector< rs2_option > get_supported_options ()
 
std::vector< rs2_option > get_supported_options ()
 

Protected Attributes

friend context
 
friend device_list
 
friend device
 
friend device_base
 
friend roi_sensor
 
std::shared_ptr< rs2_sensor > _sensor
 

Constructor & Destructor Documentation

◆ max_usable_range_sensor() [1/2]

rs2::max_usable_range_sensor::max_usable_range_sensor ( sensor  s)
inline

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

References rs2::sensor::_sensor, rs2::error::handle(), RS2_EXTENSION_MAX_USABLE_RANGE_SENSOR, and rs2_is_sensor_extendable_to().

◆ max_usable_range_sensor() [2/2]

rs2::max_usable_range_sensor::max_usable_range_sensor ( sensor  s)
inline

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

References rs2::sensor::_sensor, rs2::error::handle(), RS2_EXTENSION_MAX_USABLE_RANGE_SENSOR, and rs2_is_sensor_extendable_to().

Member Function Documentation

◆ as() [1/2]

template<class T >
T rs2::sensor::as ( ) const
inlineinherited

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

◆ as() [2/2]

template<class T >
T rs2::sensor::as ( ) const
inlineinherited

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

◆ close() [1/2]

void rs2::sensor::close ( ) const
inlineinherited

close sensor for exclusive access this method should be used for releasing sensor resource

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_close().

◆ close() [2/2]

void rs2::sensor::close ( ) const
inlineinherited

close sensor for exclusive access this method should be used for releasing sensor resource

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_close().

◆ get() [1/2]

const std::shared_ptr<rs2_sensor>& rs2::sensor::get ( ) const
inlineinherited

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

References rs2::sensor::_sensor.

◆ get() [2/2]

const std::shared_ptr<rs2_sensor>& rs2::sensor::get ( ) const
inlineinherited

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

References rs2::sensor::_sensor.

Referenced by rs2::tm2::set_intrinsics(), and rs2::tm2::set_motion_device_intrinsics().

◆ get_active_streams() [1/2]

std::vector<stream_profile> rs2::sensor::get_active_streams ( ) const
inlineinherited

Retrieves the list of stream profiles currently streaming on the sensor.

Returns
list of stream profiles that given sensor is streaming

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

References rs2::sensor::_sensor, rs2::error::handle(), rs2_delete_stream_profiles_list(), rs2_get_active_streams(), rs2_get_stream_profile(), rs2_get_stream_profiles_count(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ get_active_streams() [2/2]

std::vector<stream_profile> rs2::sensor::get_active_streams ( ) const
inlineinherited

Retrieves the list of stream profiles currently streaming on the sensor.

Returns
list of stream profiles that given sensor is streaming

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

References rs2::sensor::_sensor, rs2::error::handle(), rs2_delete_stream_profiles_list(), rs2_get_active_streams(), rs2_get_stream_profile(), rs2_get_stream_profiles_count(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ get_info() [1/2]

const char* rs2::sensor::get_info ( rs2_camera_info  info) const
inlineinherited

retrieve camera specific information, like versions of various internal components

Parameters
[in]infocamera info type to retrieve
Returns
the requested camera info string, in a format specific to the sensor model

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_get_sensor_info().

Referenced by rs2::operator==().

◆ get_info() [2/2]

const char* rs2::sensor::get_info ( rs2_camera_info  info) const
inlineinherited

retrieve camera specific information, like versions of various internal components

Parameters
[in]infocamera info type to retrieve
Returns
the requested camera info string, in a format specific to the sensor model

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_get_sensor_info().

◆ get_max_usable_depth_range() [1/2]

float rs2::max_usable_range_sensor::get_max_usable_depth_range ( ) const
inline

Retrieves the maximum range of the camera given the amount of ambient light in the scene.

Returns
max usable range in meters

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_get_max_usable_depth_range().

◆ get_max_usable_depth_range() [2/2]

float rs2::max_usable_range_sensor::get_max_usable_depth_range ( ) const
inline

Retrieves the maximum range of the camera given the amount of ambient light in the scene.

Returns
max usable range in meters

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_get_max_usable_depth_range().

◆ get_option() [1/2]

float rs2::options::get_option ( rs2_option  option) const
inlineinherited

read option's value

Parameters
[in]optionoption id to be queried
Returns
value of the option

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

References rs2::error::handle(), and rs2_get_option().

◆ get_option() [2/2]

float rs2::options::get_option ( rs2_option  option) const
inlineinherited

read option's value

Parameters
[in]optionoption id to be queried
Returns
value of the option

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

References rs2::error::handle(), and rs2_get_option().

◆ get_option_description() [1/2]

const char* rs2::options::get_option_description ( rs2_option  option) const
inlineinherited

get option description

Parameters
[in]optionoption id to be checked
Returns
human-readable option description

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

References rs2::error::handle(), and rs2_get_option_description().

◆ get_option_description() [2/2]

const char* rs2::options::get_option_description ( rs2_option  option) const
inlineinherited

get option description

Parameters
[in]optionoption id to be checked
Returns
human-readable option description

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

References rs2::error::handle(), and rs2_get_option_description().

◆ get_option_name() [1/2]

const char* rs2::options::get_option_name ( rs2_option  option) const
inlineinherited

get option name

Parameters
[in]optionoption id to be checked
Returns
human-readable option name

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

References rs2::error::handle(), and rs2_get_option_name().

◆ get_option_name() [2/2]

const char* rs2::options::get_option_name ( rs2_option  option) const
inlineinherited

get option name

Parameters
[in]optionoption id to be checked
Returns
human-readable option name

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

References rs2::error::handle(), and rs2_get_option_name().

◆ get_option_range() [1/2]

option_range rs2::options::get_option_range ( rs2_option  option) const
inlineinherited

retrieve the available range of values of a supported option

Returns
option range containing minimum and maximum values, step and default value

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

References rs2::option_range::def, rs2::error::handle(), rs2::option_range::max, rs2::option_range::min, rs2_get_option_range(), and rs2::option_range::step.

◆ get_option_range() [2/2]

option_range rs2::options::get_option_range ( rs2_option  option) const
inlineinherited

retrieve the available range of values of a supported option

Returns
option range containing minimum and maximum values, step and default value

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

References rs2::option_range::def, rs2::error::handle(), rs2::option_range::max, rs2::option_range::min, rs2_get_option_range(), and rs2::option_range::step.

◆ get_option_value_description() [1/2]

const char* rs2::options::get_option_value_description ( rs2_option  option,
float  val 
) const
inlineinherited

get option value description (in case specific option value hold special meaning)

Parameters
[in]optionoption id to be checked
[in]valvalue of the option
Returns
human-readable description of a specific value of an option or null if no special meaning

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

References rs2::error::handle(), rs2_get_option_value_description(), and val.

◆ get_option_value_description() [2/2]

const char* rs2::options::get_option_value_description ( rs2_option  option,
float  val 
) const
inlineinherited

get option value description (in case specific option value hold special meaning)

Parameters
[in]optionoption id to be checked
[in]valvalue of the option
Returns
human-readable description of a specific value of an option or null if no special meaning

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

References rs2::error::handle(), rs2_get_option_value_description(), and val.

◆ get_recommended_filters() [1/2]

std::vector<filter> rs2::sensor::get_recommended_filters ( ) const
inlineinherited

get the recommended list of filters by the sensor

Returns
list of filters that recommended by sensor

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

References rs2::sensor::_sensor, rs2::error::handle(), rs2_delete_processing_block(), rs2_delete_recommended_processing_blocks(), rs2_get_processing_block(), rs2_get_recommended_processing_blocks(), rs2_get_recommended_processing_blocks_count(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ get_recommended_filters() [2/2]

std::vector<filter> rs2::sensor::get_recommended_filters ( ) const
inlineinherited

get the recommended list of filters by the sensor

Returns
list of filters that recommended by sensor

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

References rs2::sensor::_sensor, rs2::error::handle(), rs2_delete_processing_block(), rs2_delete_recommended_processing_blocks(), rs2_get_processing_block(), rs2_get_recommended_processing_blocks(), rs2_get_recommended_processing_blocks_count(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ get_stream_profiles() [1/2]

std::vector<stream_profile> rs2::sensor::get_stream_profiles ( ) const
inlineinherited

Retrieves the list of stream profiles supported by the sensor.

Returns
list of stream profiles that given sensor can provide

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

References rs2::sensor::_sensor, rs2::error::handle(), rs2_delete_stream_profiles_list(), rs2_get_stream_profile(), rs2_get_stream_profiles(), rs2_get_stream_profiles_count(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ get_stream_profiles() [2/2]

std::vector<stream_profile> rs2::sensor::get_stream_profiles ( ) const
inlineinherited

Retrieves the list of stream profiles supported by the sensor.

Returns
list of stream profiles that given sensor can provide

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

References rs2::sensor::_sensor, rs2::error::handle(), rs2_delete_stream_profiles_list(), rs2_get_stream_profile(), rs2_get_stream_profiles(), rs2_get_stream_profiles_count(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ get_supported_options() [1/2]

std::vector<rs2_option> rs2::options::get_supported_options ( )
inlineinherited

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

References rs2_delete_options_list(), rs2_get_option_from_list(), rs2_get_options_list(), and rs2_get_options_list_size().

◆ get_supported_options() [2/2]

std::vector<rs2_option> rs2::options::get_supported_options ( )
inlineinherited

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

References rs2_delete_options_list(), rs2_get_option_from_list(), rs2_get_options_list(), and rs2_get_options_list_size().

◆ is() [1/2]

template<class T >
bool rs2::sensor::is ( ) const
inlineinherited

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

◆ is() [2/2]

template<class T >
bool rs2::sensor::is ( ) const
inlineinherited

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

◆ is_option_read_only() [1/2]

bool rs2::options::is_option_read_only ( rs2_option  option) const
inlineinherited

check if particular option is read-only

Parameters
[in]optionoption id to be checked
Returns
true if option is read-only

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

References rs2::error::handle(), and rs2_is_option_read_only().

◆ is_option_read_only() [2/2]

bool rs2::options::is_option_read_only ( rs2_option  option) const
inlineinherited

check if particular option is read-only

Parameters
[in]optionoption id to be checked
Returns
true if option is read-only

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

References rs2::error::handle(), and rs2_is_option_read_only().

◆ open() [1/4]

void rs2::sensor::open ( const std::vector< stream_profile > &  profiles) const
inlineinherited

open sensor for exclusive access, by committing to composite configuration, specifying one or more stream profiles this method should be used for interdependent streams, such as depth and infrared, that have to be configured together

Parameters
[in]profilesvector of configurations to be commited by the sensor

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_open_multiple().

◆ open() [2/4]

void rs2::sensor::open ( const std::vector< stream_profile > &  profiles) const
inlineinherited

open sensor for exclusive access, by committing to composite configuration, specifying one or more stream profiles this method should be used for interdependent streams, such as depth and infrared, that have to be configured together

Parameters
[in]profilesvector of configurations to be commited by the sensor

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_open_multiple().

◆ open() [3/4]

void rs2::sensor::open ( const stream_profile &  profile) const
inlineinherited

open sensor for exclusive access, by committing to a configuration

Parameters
[in]profileconfiguration committed by the sensor

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

References rs2::sensor::_sensor, rs2::stream_profile::get(), rs2::error::handle(), and rs2_open().

◆ open() [4/4]

void rs2::sensor::open ( const stream_profile &  profile) const
inlineinherited

open sensor for exclusive access, by committing to a configuration

Parameters
[in]profileconfiguration committed by the sensor

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

References rs2::sensor::_sensor, rs2::stream_profile::get(), rs2::error::handle(), and rs2_open().

◆ operator bool() [1/2]

rs2::max_usable_range_sensor::operator bool ( ) const
inline

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

References rs2::sensor::_sensor.

◆ operator bool() [2/2]

rs2::max_usable_range_sensor::operator bool ( ) const
inline

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

References rs2::sensor::_sensor.

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

rs2::sensor::operator std::shared_ptr< rs2_sensor > ( )
inlineexplicitinherited

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

References rs2::sensor::_sensor.

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

rs2::sensor::operator std::shared_ptr< rs2_sensor > ( )
inlineexplicitinherited

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

References rs2::sensor::_sensor.

◆ set_notifications_callback() [1/2]

template<class T >
void rs2::sensor::set_notifications_callback ( T  callback) const
inlineinherited

register notifications callback

Parameters
[in]callbacknotifications callback

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

References rs2::sensor::_sensor, rs2::error::handle(), absl::move(), and rs2_set_notifications_callback_cpp().

◆ set_notifications_callback() [2/2]

template<class T >
void rs2::sensor::set_notifications_callback ( T  callback) const
inlineinherited

register notifications callback

Parameters
[in]callbacknotifications callback

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

References rs2::sensor::_sensor, rs2::error::handle(), absl::move(), and rs2_set_notifications_callback_cpp().

◆ set_option() [1/2]

void rs2::options::set_option ( rs2_option  option,
float  value 
) const
inlineinherited

write new value to the option

Parameters
[in]optionoption id to be queried
[in]valuenew value for the option

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

References rs2::error::handle(), and rs2_set_option().

◆ set_option() [2/2]

void rs2::options::set_option ( rs2_option  option,
float  value 
) const
inlineinherited

write new value to the option

Parameters
[in]optionoption id to be queried
[in]valuenew value for the option

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

References rs2::error::handle(), and rs2_set_option().

Referenced by rs2::colorizer::colorizer(), rs2::decimation_filter::decimation_filter(), rs2::hole_filling_filter::hole_filling_filter(), rs2::pointcloud::map_to(), rs2::pointcloud::pointcloud(), rs2::sequence_id_filter::sequence_id_filter(), rs2::spatial_filter::spatial_filter(), rs2::temporal_filter::temporal_filter(), and rs2::threshold_filter::threshold_filter().

◆ start() [1/2]

template<class T >
void rs2::sensor::start ( T  callback) const
inlineinherited

Start passing frames into user provided callback.

Parameters
[in]callbackStream callback, can be any callable object accepting rs2::frame

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

References rs2::sensor::_sensor, rs2::error::handle(), absl::move(), and rs2_start_cpp().

Referenced by rs2::pose_sensor::export_localization_map().

◆ start() [2/2]

template<class T >
void rs2::sensor::start ( T  callback) const
inlineinherited

Start passing frames into user provided callback.

Parameters
[in]callbackStream callback, can be any callable object accepting rs2::frame

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

References rs2::sensor::_sensor, rs2::error::handle(), absl::move(), and rs2_start_cpp().

◆ stop() [1/2]

void rs2::sensor::stop ( ) const
inlineinherited

stop streaming

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_stop().

◆ stop() [2/2]

void rs2::sensor::stop ( ) const
inlineinherited

stop streaming

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_stop().

◆ supports() [1/7]

bool rs2::sensor::supports ( rs2_camera_info  info) const
inlineinherited

check if specific camera info is supported

Parameters
[in]infothe parameter to check for support
Returns
true if the parameter both exist and well-defined for the specific sensor

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_supports_sensor_info().

Referenced by rs2::operator==().

◆ supports() [2/7]

bool rs2::sensor::supports ( rs2_camera_info  info) const
inlineinherited

check if specific camera info is supported

Parameters
[in]infothe parameter to check for support
Returns
true if the parameter both exist and well-defined for the specific sensor

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

References rs2::sensor::_sensor, rs2::error::handle(), and rs2_supports_sensor_info().

◆ supports() [3/7]

bool rs2::options::supports ( rs2_option  option) const
inlineinherited

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

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

References rs2::error::handle(), and rs2_supports_option().

◆ supports() [4/7]

bool rs2::options::supports
inlineinherited

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

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

◆ supports() [5/7]

bool rs2::options::supports
inlineinherited

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

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

◆ supports() [6/7]

bool rs2::options::supports
inlineinherited

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

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

◆ supports() [7/7]

bool rs2::options::supports
inlineinherited

check if particular option is supported

Parameters
[in]optionoption id to be checked
Returns
true if option is supported

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

Field Documentation

◆ _sensor

std::shared_ptr< rs2_sensor > rs2::sensor::_sensor
protectedinherited

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

Referenced by rs2::software_sensor::add_motion_stream(), rs2::software_sensor::add_option(), rs2::software_sensor::add_pose_stream(), rs2::software_sensor::add_read_only_option(), rs2::software_sensor::add_video_stream(), rs2::calibrated_sensor::calibrated_sensor(), rs2::sensor::close(), rs2::color_sensor::color_sensor(), rs2::debug_stream_sensor::debug_stream_sensor(), rs2::depth_sensor::depth_sensor(), rs2::depth_stereo_sensor::depth_stereo_sensor(), rs2::software_sensor::detach(), rs2::pose_sensor::export_localization_map(), rs2::fisheye_sensor::fisheye_sensor(), rs2::sensor::get(), rs2::sensor::get_active_streams(), rs2::debug_stream_sensor::get_debug_stream_profiles(), rs2::depth_sensor::get_depth_scale(), rs2::calibrated_sensor::get_dsm_params(), rs2::sensor::get_info(), get_max_usable_depth_range(), rs2::sensor::get_recommended_filters(), rs2::roi_sensor::get_region_of_interest(), rs2::context::get_sensor_parent(), rs2::pose_sensor::get_static_node(), rs2::depth_stereo_sensor::get_stereo_baseline(), rs2::sensor::get_stream_profiles(), rs2::pose_sensor::import_localization_map(), rs2::wheel_odometer::load_wheel_odometery_config(), max_usable_range_sensor(), rs2::motion_sensor::motion_sensor(), rs2::software_sensor::on_motion_frame(), rs2::software_sensor::on_notification(), rs2::software_sensor::on_pose_frame(), rs2::software_sensor::on_video_frame(), rs2::sensor::open(), rs2::sensor::operator bool(), rs2::color_sensor::operator bool(), rs2::motion_sensor::operator bool(), rs2::fisheye_sensor::operator bool(), rs2::roi_sensor::operator bool(), rs2::depth_sensor::operator bool(), rs2::depth_stereo_sensor::operator bool(), rs2::pose_sensor::operator bool(), rs2::wheel_odometer::operator bool(), rs2::calibrated_sensor::operator bool(), operator bool(), rs2::debug_stream_sensor::operator bool(), rs2::sensor::operator std::shared_ptr< rs2_sensor >(), rs2::sensor::operator=(), rs2::calibrated_sensor::override_dsm_params(), rs2::calibrated_sensor::override_extrinsics(), rs2::calibrated_sensor::override_intrinsics(), rs2::pose_sensor::pose_sensor(), rs2::pose_sensor::remove_static_node(), rs2::calibrated_sensor::reset_calibration(), rs2::roi_sensor::roi_sensor(), rs2::wheel_odometer::send_wheel_odometry(), rs2::software_sensor::set_metadata(), rs2::sensor::set_notifications_callback(), rs2::software_sensor::set_read_only_option(), rs2::roi_sensor::set_region_of_interest(), rs2::pose_sensor::set_static_node(), rs2::sensor::start(), rs2::sensor::stop(), rs2::sensor::supports(), and rs2::wheel_odometer::wheel_odometer().

◆ context

context
protectedinherited

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

◆ device

device
protectedinherited

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

◆ device_base

device_base
protectedinherited

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

◆ device_list

device_list
protectedinherited

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

◆ roi_sensor

roi_sensor
protectedinherited

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

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