Public Member Functions | Protected Attributes | Friends | List of all members
rs2::device Class Reference

#include <rs_device.hpp>

Inheritance diagram for rs2::device:
Inheritance graph
[legend]

Public Member Functions

template<class T >
as () const
 
 device ()
 
 device (std::shared_ptr< rs2_device > dev)
 
template<class T >
first () const
 
const std::shared_ptr< rs2_device > & get () const
 
const char * get_info (rs2_camera_info info) const
 
void hardware_reset ()
 
template<class T >
bool is () const
 
 operator bool () const
 
 operator std::shared_ptr< rs2_device > ()
 
deviceoperator= (const std::shared_ptr< rs2_device > dev)
 
deviceoperator= (const device &dev)
 
std::vector< sensorquery_sensors () const
 
bool supports (rs2_camera_info info) const
 
virtual ~device ()
 

Protected Attributes

std::shared_ptr< rs2_device_dev
 

Friends

class rs2::context
 
class rs2::device_hub
 
class rs2::device_list
 
class rs2::pipeline_profile
 

Detailed Description

Definition at line 18 of file rs_device.hpp.

Constructor & Destructor Documentation

rs2::device::device ( )
inline

Definition at line 110 of file rs_device.hpp.

virtual rs2::device::~device ( )
inlinevirtual

Definition at line 134 of file rs_device.hpp.

rs2::device::device ( std::shared_ptr< rs2_device dev)
inlineexplicit

Definition at line 139 of file rs_device.hpp.

Member Function Documentation

template<class T >
T rs2::device::as ( ) const
inline

Definition at line 129 of file rs_device.hpp.

template<class T >
T rs2::device::first ( ) const
inline

Definition at line 52 of file rs_device.hpp.

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

Definition at line 116 of file rs_device.hpp.

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

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

Definition at line 79 of file rs_device.hpp.

void rs2::device::hardware_reset ( )
inline

send hardware reset request to the device

Definition at line 90 of file rs_device.hpp.

template<class T >
bool rs2::device::is ( ) const
inline

Definition at line 122 of file rs_device.hpp.

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

Definition at line 112 of file rs_device.hpp.

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

Definition at line 138 of file rs_device.hpp.

device& rs2::device::operator= ( const std::shared_ptr< rs2_device dev)
inline

Definition at line 98 of file rs_device.hpp.

device& rs2::device::operator= ( const device dev)
inline

Definition at line 104 of file rs_device.hpp.

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

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

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

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 device

Definition at line 66 of file rs_device.hpp.

Friends And Related Function Documentation

friend class rs2::context
friend

Definition at line 141 of file rs_device.hpp.

friend class rs2::device_hub
friend

Definition at line 144 of file rs_device.hpp.

friend class rs2::device_list
friend

Definition at line 142 of file rs_device.hpp.

friend class rs2::pipeline_profile
friend

Definition at line 143 of file rs_device.hpp.

Member Data Documentation

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

Definition at line 146 of file rs_device.hpp.


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


librealsense2
Author(s): Sergey Dorodnicov , Doron Hirshberg , Mark Horn , Reagan Lopez , Itay Carpis
autogenerated on Mon May 3 2021 02:50:40