#include <rs_sensor.hpp>

Inheritance diagram for rs2::sensor:

[legend]

Public Member Functions
template<class T >
T	as () const

void	close () const

const std::shared_ptr< rs2_sensor > &	get () const

std::vector< stream_profile >	get_active_streams () const

const char *	get_info (rs2_camera_info info) const

std::vector< filter >	get_recommended_filters () const

std::vector< stream_profile >	get_stream_profiles () const

template<class T >
bool	is () const

void	open (const stream_profile &profile) const

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

	operator bool () const

	operator std::shared_ptr< rs2_sensor > ()

sensor &	operator= (const std::shared_ptr< rs2_sensor > other)

sensor &	operator= (const sensor &other)

	sensor ()

	sensor (std::shared_ptr< rs2_sensor > dev)

template<class T >
void	set_notifications_callback (T callback) const

template<class T >
void	start (T callback) const

void	stop () const

bool	supports (rs2_camera_info info) const

Public Member Functions inherited from rs2::options
float	get_option (rs2_option option) const

const char *	get_option_description (rs2_option option) const

const char *	get_option_name (rs2_option option) const

option_range	get_option_range (rs2_option option) const

const char *	get_option_value_description (rs2_option option, float val) const

std::vector< rs2_option >	get_supported_options ()

bool	is_option_read_only (rs2_option option) const

options &	operator= (const options &other)

	options (const options &other)

void	set_option (rs2_option option, float value) const

bool	supports (rs2_option option) const

virtual	~options ()=default

Protected Attributes
std::shared_ptr< rs2_sensor >	_sensor

friend	context

friend	device

friend	device_base

friend	device_list

friend	roi_sensor

Additional Inherited Members
Protected Member Functions inherited from rs2::options
template<class T >
options &	operator= (const T &dev)

	options (rs2_options *o=nullptr)

Detailed Description

Definition at line 102 of file rs_sensor.hpp.

Constructor & Destructor Documentation

rs2::sensor::sensor ( )

inline

Definition at line 313 of file rs_sensor.hpp.

rs2::sensor::sensor ( std::shared_ptr< rs2_sensor > dev )

inlineexplicit

Definition at line 339 of file rs_sensor.hpp.

Member Function Documentation

template<class T >

T rs2::sensor::as ( ) const

inline

Definition at line 333 of file rs_sensor.hpp.

void rs2::sensor::close ( ) const

inline

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

Definition at line 173 of file rs_sensor.hpp.

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

inline

Definition at line 320 of file rs_sensor.hpp.

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

inline

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

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

inline

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 sensor model

Definition at line 138 of file rs_sensor.hpp.

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

inline

get the recommended list of filters by the sensor

Returns: list of filters that recommended by sensor

Definition at line 273 of file rs_sensor.hpp.

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

inline

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

template<class T >

bool rs2::sensor::is ( ) const

inline

Definition at line 326 of file rs_sensor.hpp.

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

inline

open sensor for exclusive access, by committing to a configuration

Parameters

[in] profile configuration committed by the sensor

Definition at line 111 of file rs_sensor.hpp.

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

inline

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] profiles vector of configurations to be commited by the sensor

Definition at line 151 of file rs_sensor.hpp.

rs2::sensor::operator bool ( ) const

inline

Definition at line 315 of file rs_sensor.hpp.

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

inlineexplicit

Definition at line 343 of file rs_sensor.hpp.

sensor& rs2::sensor::operator= ( const std::shared_ptr< rs2_sensor > other )

inline

Definition at line 298 of file rs_sensor.hpp.

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

inline

Definition at line 306 of file rs_sensor.hpp.

template<class T >

void rs2::sensor::set_notifications_callback ( T callback ) const

inline

register notifications callback

Parameters

[in] callback notifications callback

Definition at line 207 of file rs_sensor.hpp.

template<class T >

void rs2::sensor::start ( T callback ) const

inline

Start passing frames into user provided callback

Parameters

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

Definition at line 185 of file rs_sensor.hpp.

void rs2::sensor::stop ( ) const

inline

stop streaming

Definition at line 195 of file rs_sensor.hpp.

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

inline

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 sensor

Definition at line 125 of file rs_sensor.hpp.

Member Data Documentation

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

protected

Definition at line 352 of file rs_sensor.hpp.

friend rs2::sensor::context

protected

Definition at line 346 of file rs_sensor.hpp.

friend rs2::sensor::device

protected

Definition at line 348 of file rs_sensor.hpp.

friend rs2::sensor::device_base

protected

Definition at line 349 of file rs_sensor.hpp.

friend rs2::sensor::device_list

protected

Definition at line 347 of file rs_sensor.hpp.

friend rs2::sensor::roi_sensor

protected

Definition at line 350 of file rs_sensor.hpp.

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

rs_sensor.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation