this experiment performs a DC current sweep from the starting current to the ending current which progresses linearly according to the scan rate. More...

#include <AisDCCurrentSweepElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisDCCurrentSweepElement (double startCurrent, double endCurrent, double scanRate, double samplingInterval)
	the DC current sweep element. More...

	AisDCCurrentSweepElement (const AisDCCurrentSweepElement &)
	copy constructor for the AisDCCurrentSweepElement object.

AisDCCurrentSweepElement &	operator= (const AisDCCurrentSweepElement &)
	overload equal to operator for the AisDCCurrentSweepElement object.

QString	getName () const override
	get the name of the element. More...

QStringList	getCategory () const override
	get a list of applicable categories of the element. More...

double	getQuietTime () const
	Gets the quiet time duration. More...

void	setQuietTime (double quietTime)
	Sets the quiet time duration. More...

double	getQuietTimeSamplingInterval () const
	gets the quiet time sampling interval. More...

void	setQuietTimeSamplingInterval (double quietTimeSamplingInterval)
	Sets the quiet time sampling interval. More...

double	getStartingCurrent () const
	get the value set for the starting current. More...

void	setStartingCurrent (double startingCurrent)
	set the value for the starting current. More...

double	getEndingCurrent () const
	get the value set for the ending current. More...

void	setEndingCurrent (double endingCurrent)
	set the value for the ending current. More...

double	getScanRate () const
	get the value set for the scan rate. More...

void	setScanRate (double scanRate)
	set the value for the current scan rate. More...

double	getSamplingInterval () const
	get how frequently we are sampling the data. More...

void	setSamplingInterval (double samplingInterval)
	set how frequently we are sampling the data. More...

double	getMaxVoltage () const
	get the value set for the maximum voltage. The experiment will end when it reaches this value. More...

void	setMaxVoltage (double maxVoltage)
	set a maximum voltage to stop the experiment. More...

double	getMinVoltage () const
	get the value set minimum for the voltage in volts. More...

void	setMinVoltage (double minVoltage)
	set a minimum voltage to stop the experiment. More...

double	getAlphaFactor () const
	Get the value set for the alpha factor. More...

void	setAlphaFactor (double alphaFactor)
	alpha factor controls the percentage of data sampled during a given interval. Data will be averaged over the last n% of the sampling interval. More...

Detailed Description

this experiment performs a DC current sweep from the starting current to the ending current which progresses linearly according to the scan rate.

Constructor & Destructor Documentation

◆ AisDCCurrentSweepElement()

AisDCCurrentSweepElement::AisDCCurrentSweepElement	(	double	startCurrent,
		double	endCurrent,
		double	scanRate,
		double	samplingInterval
	)

explicit

the DC current sweep element.

Parameters

startCurrent	the value for the starting current in Amps.
endCurrent	the value for the ending current in Amps.
scanRate	the value for the current scan rate in A/s.
samplingInterval	how frequently we are sampling the data.

Member Function Documentation

◆ getAlphaFactor()

double AisDCCurrentSweepElement::getAlphaFactor ( ) const

Get the value set for the alpha factor.

Returns: The value for the alpha factor is represented as a percent between 0 and 100.

Note: If nothing is set, this function will return a default value of 75.

◆ getCategory()

QStringList AisDCCurrentSweepElement::getCategory ( ) const

override

get a list of applicable categories of the element.

Returns: A list of applicable categories: ("Galvanostatic Control", "Basic Voltammetry").

◆ getEndingCurrent()

double AisDCCurrentSweepElement::getEndingCurrent ( ) const

get the value set for the ending current.

Returns: the value for the ending current in Amps.

◆ getMaxVoltage()

double AisDCCurrentSweepElement::getMaxVoltage ( ) const

get the value set for the maximum voltage. The experiment will end when it reaches this value.

Returns: the value set for the maximum voltage.

Note: this is an optional parameter. If no value has been set, the default value is positive infinity

◆ getMinVoltage()

double AisDCCurrentSweepElement::getMinVoltage ( ) const

get the value set minimum for the voltage in volts.

Returns: the value set for the minimum voltage in volts.

Note: this is an optional parameter. If no value has been set, the default value is negative infinity

◆ getName()

QString AisDCCurrentSweepElement::getName ( ) const

override

get the name of the element.

Returns: The name of the element: "DC Current Linear Sweep".

◆ getQuietTime()

double AisDCCurrentSweepElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns: The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisDCCurrentSweepElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

Returns: samplingInterval The quiet time sampling interval to set in seconds.

◆ getSamplingInterval()

double AisDCCurrentSweepElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ getScanRate()

double AisDCCurrentSweepElement::getScanRate ( ) const

get the value set for the scan rate.

Returns: the value set for the scan rate in A/s.

See also: setScanRate

◆ getStartingCurrent()

double AisDCCurrentSweepElement::getStartingCurrent ( ) const

get the value set for the starting current.

Returns: the value set for the constant current in Amps.

◆ setAlphaFactor()

void AisDCCurrentSweepElement::setAlphaFactor ( double alphaFactor )

alpha factor controls the percentage of data sampled during a given interval. Data will be averaged over the last n% of the sampling interval.

This is an optional parameter. If nothing is set, the device will use the default value of 75.

Parameters

alphaFactor the value for the alphaFactor ranges from 0 to 100.

◆ setEndingCurrent()

void AisDCCurrentSweepElement::setEndingCurrent ( double endingCurrent )

set the value for the ending current.

Parameters

endingCurrent the value for the ending current in Amps

◆ setMaxVoltage()

void AisDCCurrentSweepElement::setMaxVoltage ( double maxVoltage )

set a maximum voltage to stop the experiment.

This is an optional condition. If nothing is set, then the experiment will not stop based on an upper-limit voltage value. If a maximum voltage is set, the experiment will continue to run as long as the measured voltage is below that value.

Parameters

maxVoltage the maximum voltage value in volts at which the experiment will stop.

◆ setMinVoltage()

void AisDCCurrentSweepElement::setMinVoltage ( double minVoltage )

set a minimum voltage to stop the experiment.

This is an optional condition. If nothing is set, then the experiment will not stop based on an lower-limit voltage value. If a maximum voltage is set, the experiment will continue to run as long as the measured voltage is above that value.

Parameters

minVoltage the minimum voltage value in volts at which the experiment will stop.

◆ setQuietTime()

void AisDCCurrentSweepElement::setQuietTime ( double quietTime )

Sets the quiet time duration.

Parameters

quietTime The quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisDCCurrentSweepElement::setQuietTimeSamplingInterval ( double quietTimeSamplingInterval )

Sets the quiet time sampling interval.

Parameters

quietTimeSamplingInterval The quiet time sampling interval to set in seconds.

◆ setSamplingInterval()

void AisDCCurrentSweepElement::setSamplingInterval ( double samplingInterval )

set how frequently we are sampling the data.

Parameters

samplingInterval the data sampling interval value in seconds.

◆ setScanRate()

void AisDCCurrentSweepElement::setScanRate ( double scanRate )

set the value for the current scan rate.

The scan rate represents the value of the discrete current step size in one second in the linear sweep.

Parameters

scanRate the value to set for the scan rate.

◆ setStartingCurrent()

void AisDCCurrentSweepElement::setStartingCurrent ( double startingCurrent )

set the value for the starting current.

Parameters

startingCurrent the value to set for the starting current in Amps

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

AisDCCurrentSweepElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisDCCurrentSweepElement()

Member Function Documentation

◆ getAlphaFactor()

◆ getCategory()

◆ getEndingCurrent()

◆ getMaxVoltage()

◆ getMinVoltage()

◆ getName()

◆ getQuietTime()

◆ getQuietTimeSamplingInterval()

◆ getSamplingInterval()

◆ getScanRate()

◆ getStartingCurrent()

◆ setAlphaFactor()

◆ setEndingCurrent()

◆ setMaxVoltage()

◆ setMinVoltage()

◆ setQuietTime()

◆ setQuietTimeSamplingInterval()

◆ setSamplingInterval()

◆ setScanRate()

◆ setStartingCurrent()