Sensors::Imagenex852::SwitchData Class Reference

Detailed Description

Imagenex 852 Switch Data.

Public Member Functions
	SwitchData (void)
bool	setStartGain (uint8_t gain)
uint8_t	getStartGain (void) const
bool	setRange (uint8_t range)
uint8_t	getRange (void)
void	setDataPoints (unsigned dpoints)
unsigned	getDataPoints (void) const
bool	setProfileMinRange (fp32_t min_range)
double	getProfileMinRange (void) const
bool	setPulseLength (fp32_t length)
fp32_t	getPulseLength (void) const
const uint8_t *	data (void) const
unsigned	size (void) const

Constructor & Destructor Documentation

Sensors::Imagenex852::SwitchData::SwitchData ( void  )

inline

Constructor.

References setDataPoints(), and setStartGain().

Member Function Documentation

const uint8_t* Sensors::Imagenex852::SwitchData::data ( void  ) const

inline

Retrieve the switch data.

Returns

switch data.

Referenced by Sensors::Imagenex852::Task::onResourceInitialization().

unsigned Sensors::Imagenex852::SwitchData::getDataPoints ( void  ) const

inline

Get number of data points from switch data command.

Returns

number of data points.

double Sensors::Imagenex852::SwitchData::getProfileMinRange ( void  ) const

inline

Get profile minimum range from switch data command.

Returns

profile minimum range value.

Referenced by Sensors::Imagenex852::Task::onMain().

fp32_t Sensors::Imagenex852::SwitchData::getPulseLength ( void  ) const

inline

Get pulse length from switch data command.

Returns

pulse length value.

uint8_t Sensors::Imagenex852::SwitchData::getRange ( void  )

inline

Get range from switch data command.

Returns

range value.

Referenced by Sensors::Imagenex852::Task::filterRange().

uint8_t Sensors::Imagenex852::SwitchData::getStartGain ( void  ) const

inline

Get start gain from switch data command.

Returns

start gain value.

void Sensors::Imagenex852::SwitchData::setDataPoints ( unsigned  dpoints )

inline

Set number of sonar return data points.

Parameters

[in]

dpoints

number of sonar return data points.

Referenced by Sensors::Imagenex852::Task::onUpdateParameters(), and SwitchData().

bool Sensors::Imagenex852::SwitchData::setProfileMinRange ( fp32_t  min_range )

inline

Set profile minimum range.

Parameters

[in]

min_range

profile minimum range value. return true if successful, false otherwise.

Referenced by Sensors::Imagenex852::Task::onUpdateParameters().

bool Sensors::Imagenex852::SwitchData::setPulseLength ( fp32_t  length )

inline

Set length of acoustic transmit pulse.

Parameters

[in]

length

pulse length value. return true.

Referenced by Sensors::Imagenex852::Task::onUpdateParameters().

bool Sensors::Imagenex852::SwitchData::setRange ( uint8_t  range )

inline

Set range value.

Parameters

[in]

range

range value. return true if successful, false otherwise.

Referenced by Sensors::Imagenex852::Task::onUpdateParameters().

bool Sensors::Imagenex852::SwitchData::setStartGain ( uint8_t  gain )

inline

Set start gain.

Parameters

[in]

gain

start gain value. return true.

Referenced by Sensors::Imagenex852::Task::onUpdateParameters(), and SwitchData().

unsigned Sensors::Imagenex852::SwitchData::size ( void  ) const

inline

Retrieve the size of the switch data.

Returns

size of the switch data.

Referenced by Sensors::Imagenex852::Task::onResourceInitialization().

Collaboration diagram for Sensors::Imagenex852::SwitchData: