Detailed Description

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

Inheritance diagram for rs2::options:

[legend]

Public Member Functions
bool	supports (rs2_option option) const
	check if particular option is supported 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_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...

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...

bool	is_option_read_only (rs2_option option) const
	check if particular option is read-only More...

std::vector< rs2_option >	get_supported_options ()

options &	operator= (const options &other)

	options (const options &other)

virtual	~options ()=default

bool	supports (rs2_option option) const
	check if particular option is supported 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_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...

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...

bool	is_option_read_only (rs2_option option) const
	check if particular option is read-only More...

std::vector< rs2_option >	get_supported_options ()

options &	operator= (const options &other)

	options (const options &other)

virtual	~options ()=default

Protected Member Functions
	options (rs2_options *o=nullptr)

template<class T >
options &	operator= (const T &dev)

	options (rs2_options *o=nullptr)

template<class T >
options &	operator= (const T &dev)

Constructor & Destructor Documentation

◆ options() [1/4]

rs2::options::options ( const options & other )

inline

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

◆ ~options() [1/2]

virtual rs2::options::~options ( )

virtualdefault

◆ options() [2/4]

rs2::options::options ( rs2_options * o = nullptr )

inlineexplicitprotected

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

◆ options() [3/4]

rs2::options::options ( const options & other )

inline

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

◆ ~options() [2/2]

virtual rs2::options::~options ( )

virtualdefault

◆ options() [4/4]

rs2::options::options ( rs2_options * o = nullptr )

inlineexplicitprotected

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

Member Function Documentation

◆ get_option() [1/2]

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

inline

read option's value

Parameters

[in] option option 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

inline

read option's value

Parameters

[in] option option 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

inline

get option description

Parameters

[in] option option 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_description() [2/2]

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

inline

get option description

Parameters

[in] option option 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_name() [1/2]

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

inline

get option name

Parameters

[in] option option 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

inline

get option name

Parameters

[in] option option 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

inline

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_range() [2/2]

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

inline

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_value_description() [1/2]

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

inline

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

Parameters

[in]	option	option id to be checked
[in]	val	value 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

inline

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

Parameters

[in]	option	option id to be checked
[in]	val	value 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_supported_options() [1/2]

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

inline

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 ( )

inline

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_option_read_only() [1/2]

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

inline

check if particular option is read-only

Parameters

[in] option option 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

inline

check if particular option is read-only

Parameters

[in] option option 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().

◆ operator=() [1/4]

options& rs2::options::operator= ( const options & other )

inline

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

◆ operator=() [2/4]

options& rs2::options::operator= ( const options & other )

inline

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

Referenced by rs2::sensor::operator=(), and rs2::processing_block::processing_block().

◆ operator=() [3/4]

template<class T >

options& rs2::options::operator= ( const T & dev )

inlineprotected

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

◆ operator=() [4/4]

template<class T >

options& rs2::options::operator= ( const T & dev )

inlineprotected

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

◆ set_option() [1/2]

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

inline

write new value to the option

Parameters

[in]	option	option id to be queried
[in]	value	new 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().

◆ set_option() [2/2]

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

inline

write new value to the option

Parameters

[in]	option	option id to be queried
[in]	value	new 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().

◆ supports() [1/2]

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

inline

check if particular option is supported

Parameters

[in] option option 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() [2/2]

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

inline

check if particular option is supported

Parameters

[in] option option 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.

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

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

sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_options.hpp

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ options() [1/4]

◆ ~options() [1/2]

◆ options() [2/4]

◆ options() [3/4]

◆ ~options() [2/2]

◆ options() [4/4]

Member Function Documentation

◆ get_option() [1/2]

◆ get_option() [2/2]

◆ get_option_description() [1/2]

◆ get_option_description() [2/2]

◆ get_option_name() [1/2]

◆ get_option_name() [2/2]

◆ get_option_range() [1/2]

◆ get_option_range() [2/2]

◆ get_option_value_description() [1/2]

◆ get_option_value_description() [2/2]

◆ get_supported_options() [1/2]

◆ get_supported_options() [2/2]

◆ is_option_read_only() [1/2]

◆ is_option_read_only() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ set_option() [1/2]

◆ set_option() [2/2]

◆ supports() [1/2]

◆ supports() [2/2]