Public Member Functions | Private Attributes | List of all members
crl::multisense::lighting::Config Class Reference

#include <MultiSenseTypes.hh>

Public Member Functions

 Config ()
 
float getDutyCycle (uint32_t i) const
 
bool getFlash () const
 
bool setDutyCycle (float percent)
 
bool setDutyCycle (uint32_t i, float percent)
 
void setFlash (bool onOff)
 

Private Attributes

std::vector< float > m_dutyCycle
 
bool m_flashEnabled
 

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
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
//
// Create a lightingConfig instance to store our queried lighting configuration
//
// 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
throw std::runtime_error("Unable to query lighting configuration");
}
//
// Use the lighting configuration...
//
// Destroy the channel instance

Example code to set a lighting configuration:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
//
// Create a lightingConfig instance to store our queried lighting configuration
//
// Query the lighting configuration from the Channel instance
status = channel->getLightingConfig(lightingConfig);
//
// Check to see if the lighting configuration query was successful
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.setFlash(true);
//
// Set the new lighting configuration
status = channel->setLightingConfig(lightingConfig);
//
// Check to see if the new lighting configuration was successfully
// received
throw std::runtime_error("Unable to set lighting configuration");
}
//
// Destroy the channel instance

Definition at line 1659 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

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

Default constructor. Flashing is disabled and all lights are off

Definition at line 1738 of file MultiSenseTypes.hh.

Member Function Documentation

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
iThe index of the light to query
Returns
The current duty cycle setting for the light corresponding to index i

Definition at line 1728 of file MultiSenseTypes.hh.

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 1678 of file MultiSenseTypes.hh.

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
percentThe 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 1688 of file MultiSenseTypes.hh.

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
iThe index of the light to configure
percentThe 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 1709 of file MultiSenseTypes.hh.

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
onOffA boolean flag to enable or disable flashing

Definition at line 1670 of file MultiSenseTypes.hh.

Member Data Documentation

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

Definition at line 1743 of file MultiSenseTypes.hh.

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

Definition at line 1738 of file MultiSenseTypes.hh.


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


multisense_lib
Author(s):
autogenerated on Sun Mar 14 2021 02:34:50