crl::multisense::lighting::Config Class Reference

Class used to store a specific lighting configuration. More...

#include <MultiSenseTypes.hh>

Public Member Functions
void	setFlash (bool onOff)
	Turn on/off light flashing. More...
bool	getFlash () const
	Get the current lighting flash setting. More...
bool	setDutyCycle (float percent)
	Set a sensors duty cycle in terms of percent for all the on-board lights. More...
bool	setDutyCycle (uint32_t i, float percent)
	Set a sensors duty cycle in terms of percent for a specific light based off its index. More...
float	getDutyCycle (uint32_t i) const
	Get the current duty cycle in terms of percent for a specific light. More...
	Config ()
	Default constructor. More...

Private Attributes
bool	m_flashEnabled
std::vector< float >	m_dutyCycle

Detailed Description

Class used to store a specific lighting configuration.

Member of this class are set and queried via set and get methods. This class is used as an input to a channel object to query and set lighting parameters.

Example code to query a lighting configuration:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
crl::multisense::Channel* channel;
channel = crl::multisense::Channel::Create("10.66.171.21");
 
channel->setMtu(7200);
 
//
// Create a lightingConfig instance to store our queried lighting configuration
crl::multisense::lighting::Config lightingConfig;
 
//
// Query the lighting configuration from the Channel instance
crl::multisense::Status status = channel->getLightingConfig(lightingConfig);
 
//
// Check to see if the lighting configuration query was successful
if(crl::multisense::Status_Ok != status) {
     throw std::runtime_error("Unable to query lighting configuration");
}
 
//
// Use the lighting configuration...
 
//
// Destroy the channel instance
crl::multisense::Channel::Destroy(channel);

Example code to set a lighting configuration:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
crl::multisense::Channel* channel;
channel = crl::multisense::Channel::Create("10.66.171.21");
 
channel->setMtu(7200);
 
//
// Create a lightingConfig instance to store our queried lighting configuration
crl::multisense::lighting::Config lightingConfig;
 
crl::multisense::Status status;
 
//
// Query the lighting configuration from the Channel instance
status  = channel->getLightingConfig(lightingConfig);
 
//
// Check to see if the lighting configuration query was successful
if(crl::multisense::Status_Ok != status) {
     throw std::runtime_error("Unable to query lighting configuration");
}
 
//
// Change the duty cycle for all light to the max setting and enable
// light flashing
lightingConfig.setDutyCycle(crl::multisense::lighting::MAX_DUTY_CYCLE);
lightingConfig.setFlash(true);
 
//
// Set the new lighting configuration
status = channel->setLightingConfig(lightingConfig);
 
//
// Check to see if the new lighting configuration was successfully
// received
if(crl::multisense::Status_Ok != status) {
     throw std::runtime_error("Unable to set lighting configuration");
}
 
//
// Destroy the channel instance
crl::multisense::Channel::Destroy(channel);

Definition at line 1988 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

Config()

crl::multisense::lighting::Config::Config ( )

inline

Default constructor.

Flashing is disabled and all lights are off

Definition at line 2067 of file MultiSenseTypes.hh.

Member Function Documentation

getDutyCycle()

float crl::multisense::lighting::Config::getDutyCycle ( uint32_t  i ) const

inline

Get the current duty cycle in terms of percent for a specific light.

Parameters

i	The index of the light to query

Returns

The current duty cycle setting for the light corresponding to index i

Definition at line 2057 of file MultiSenseTypes.hh.

getFlash()

bool crl::multisense::lighting::Config::getFlash ( ) const

inline

Get the current lighting flash setting.

Returns

A boolean flag corresponding to if flashing is enabled or disabled

Definition at line 2007 of file MultiSenseTypes.hh.

setDutyCycle() [1/2]

bool crl::multisense::lighting::Config::setDutyCycle ( float  percent )

inline

Set a sensors duty cycle in terms of percent for all the on-board lights.

Parameters

percent

The percent "on" to set all the on-board LED's [0.0, 100.0]

Returns

If the given percent setting is valid

Definition at line 2017 of file MultiSenseTypes.hh.

setDutyCycle() [2/2]

bool crl::multisense::lighting::Config::setDutyCycle ( uint32_t  i, float  percent  )

inline

Set a sensors duty cycle in terms of percent for a specific light based off its index.

Parameters

i	The index of the light to configure
percent	The percent "on" to set all the on-board LED's [0.0, 100.0]

Returns

If the given percent setting is valid

Definition at line 2038 of file MultiSenseTypes.hh.

setFlash()

void crl::multisense::lighting::Config::setFlash ( bool  onOff )

inline

Turn on/off light flashing.

During flashing lights are only on when the image sensor is exposing. This significantly reduces the sensor power consumption

Parameters

onOff

A boolean flag to enable or disable flashing

Definition at line 1999 of file MultiSenseTypes.hh.

Member Data Documentation

m_dutyCycle

std::vector<float> crl::multisense::lighting::Config::m_dutyCycle

private

Definition at line 2072 of file MultiSenseTypes.hh.

m_flashEnabled

bool crl::multisense::lighting::Config::m_flashEnabled

private

Definition at line 2067 of file MultiSenseTypes.hh.

---

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

• /home/malvarado/crl/LibMultiSense/source/LibMultiSense/include/MultiSense/MultiSenseTypes.hh