LibMultiSense
LibMultiSense Documentation
crl::multisense::system::DeviceMode Class Reference

Class used query the device modes for a given sensor. More...

#include <MultiSenseTypes.hh>

Public Member Functions

 DeviceMode (uint32_t w=0, uint32_t h=0, DataSource d=0, int32_t s=-1)
 Constructor. More...
 

Public Attributes

uint32_t width
 The image width configuration for a given device mode. More...
 
uint32_t height
 The image height configuration for a given device mode. More...
 
DataSource supportedDataSources
 A listing of all the data sources available for a specific device mode. More...
 
int32_t disparities
 The number of valid disparities for a given device mode. More...
 

Detailed Description

Class used query the device modes for a given sensor.

Example code to query all the available device modes for a sensor.

channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
std::vector<crl::multisense::system::DeviceMode> deviceModeVect;
crl::multisense::Status status = channel->getDeviceModes(deviceModeVect));
throw std::runtime_error("Unable to query device modes info");
}
//
// Use the device modes...

Definition at line 3056 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ DeviceMode()

crl::multisense::system::DeviceMode::DeviceMode ( uint32_t  w = 0,
uint32_t  h = 0,
DataSource  d = 0,
int32_t  s = -1 
)
inline

Constructor.

Parameters
wThe device mode width. Default value: 0
hThe device mode height. Default value: 0
dThe available data sources. Default value: 0
sThe number of valid disparities. Default value: -1

Definition at line 3079 of file MultiSenseTypes.hh.

Member Data Documentation

◆ disparities

int32_t crl::multisense::system::DeviceMode::disparities

The number of valid disparities for a given device mode.

Definition at line 3066 of file MultiSenseTypes.hh.

◆ height

uint32_t crl::multisense::system::DeviceMode::height

The image height configuration for a given device mode.

Definition at line 3062 of file MultiSenseTypes.hh.

◆ supportedDataSources

DataSource crl::multisense::system::DeviceMode::supportedDataSources

A listing of all the data sources available for a specific device mode.

Definition at line 3064 of file MultiSenseTypes.hh.

◆ width

uint32_t crl::multisense::system::DeviceMode::width

The image width configuration for a given device mode.

Definition at line 3060 of file MultiSenseTypes.hh.


The documentation for this class was generated from the following file:
crl::multisense::Channel
Class which manages all communications with a MultiSense device.
Definition: MultiSenseChannel.hh:69
crl::multisense::Status_Ok
static CRL_CONSTEXPR Status Status_Ok
Definition: MultiSenseTypes.hh:98
crl::multisense::Channel::Destroy
static void Destroy(Channel *instanceP)
Destroy a channel instance that was created using the static member function Channel::Create().
crl::multisense::Channel::getDeviceModes
virtual Status getDeviceModes(std::vector< system::DeviceMode > &m)=0
Query the available sensor device modes.
crl::multisense::Status
int32_t Status
General status typdef used as a return value for get/set crl::multisense::Channel methods.
Definition: MultiSenseTypes.hh:93
crl::multisense::Channel::setMtu
virtual Status setMtu(int32_t mtu)=0
Set the current sensor's MTU.
crl::multisense::Channel::Create
static Channel * Create(const std::string &sensorAddress)
Create a Channel instance, used to manage all communications with a sensor.