Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | Protected Attributes | Friends | List of all members
rs2::device Class Reference

#include <rs_device.hpp>

Inheritance diagram for rs2::device:
rs2::calibrated_device rs2::calibration_change_device rs2::debug_protocol rs2::firmware_logger rs2::playback rs2::recorder rs2::serializable_device rs2::software_device rs2::updatable rs2::update_device

Public Member Functions

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

Protected Attributes

std::shared_ptr< rs2_device_dev
 

Friends

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

Constructor & Destructor Documentation

◆ device() [1/2]

rs2::device::device ( )
inline

◆ ~device()

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

◆ device() [2/2]

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

Member Function Documentation

◆ as()

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

◆ first()

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

◆ get()

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

◆ get_description()

std::string rs2::device::get_description ( ) const
inline
Returns
the one-line description: "[<type>] <name> s/n <#>"

◆ get_info()

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

◆ get_type()

std::string rs2::device::get_type ( ) const
inline
Returns
the type of device: USB/GMSL/DDS, etc.

◆ hardware_reset()

void rs2::device::hardware_reset ( )
inline

send hardware reset request to the device

◆ is()

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

◆ is_connected()

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

◆ operator bool()

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

◆ operator std::shared_ptr< rs2_device >()

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

◆ operator<()

bool rs2::device::operator< ( device const &  other) const
inline

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ query_sensors()

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

◆ supports()

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

Friends And Related Function Documentation

◆ rs2::context

friend class rs2::context
friend

◆ rs2::device_hub

friend class rs2::device_hub
friend

◆ rs2::device_list

friend class rs2::device_list
friend

◆ rs2::pipeline_profile

friend class rs2::pipeline_profile
friend

Member Data Documentation

◆ _dev

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

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