AisCompRange Class Reference

This class has advanced options controlling the device stability including the bandwidth index and the stability factor. More...

#include <AisCompRange.h>

Public Member Functions
	AisCompRange (const QString &compRangeName, uint8_t bandwidthIndex, uint8_t stabilityFactor)
	constructor for the compensation-range object. More...
	AisCompRange (const AisCompRange &)
	copy constructor for the compensation-range object.
uint8_t	getBandwidthIndex () const
	get the value set for the bandwidth index. More...
void	setBandwidthIndex (uint8_t index)
	set the index value for the bandwidth. More...
uint8_t	getStabilityFactor () const
	get the value set for the stability factor. More...
void	setStabilityFactor (uint8_t factor)
	set a value for the stability factor. More...
void	setCompRangeName (const QString &compRangeName)
	set a name for the compensation range for reference purposes. More...
const QString &	getCompRangeName () const
	get the name set for the compensation range. More...

Detailed Description

This class has advanced options controlling the device stability including the bandwidth index and the stability factor.

See also

setBandwidthIndex

setStabilityFactor

Constructor & Destructor Documentation

AisCompRange()

AisCompRange::AisCompRange ( const QString &  compRangeName, uint8_t  bandwidthIndex, uint8_t  stabilityFactor  )

explicit

constructor for the compensation-range object.

Parameters

compRangeName	a name to set for the compensation range for reference purposes.
bandwidthIndex	the index value for the bandwidth.
stabilityFactor	the factor value for the stability.

See also

setBandwidthIndex

setStabilityFactor

Member Function Documentation

getBandwidthIndex()

uint8_t AisCompRange::getBandwidthIndex

(

)

const

get the value set for the bandwidth index.

Returns

the set value for the bandwidth index.

See also

setBandwidthIndex

getCompRangeName()

const QString & AisCompRange::getCompRangeName

(

)

const

get the name set for the compensation range.

Returns

the name set for the compensation range.

getStabilityFactor()

uint8_t AisCompRange::getStabilityFactor

(

)

const

get the value set for the stability factor.

Returns

the value set for the stability factor.

setBandwidthIndex()

void AisCompRange::setBandwidthIndex

(

uint8_t

index

)

set the index value for the bandwidth.

Usually, the device's default index value is optimal for running experiments. You may still increase the index within the range 0-10 as you run higher frequency experiments to see what best fits.

Parameters

index

the index value for the bandwidth (0-10).

setCompRangeName()

void AisCompRange::setCompRangeName

(

const QString &

compRangeName

)

set a name for the compensation range for reference purposes.

Parameters

compRangeName

the name to set for the compensation range.

setStabilityFactor()

void AisCompRange::setStabilityFactor

(

uint8_t

factor

)

set a value for the stability factor.

Usually, the device's default factor value is optimal for running experiments. You may still increase the factor within the range 0-10 as you run experiments with more oscillations to see what best fits.

Parameters

factor

the stability-factor value (0-10)

---

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

• AisCompRange.h