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

#include <AisDCPotentialSweepElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisDCPotentialSweepElement (double startPotential, double endPotential, double scanRate, double samplingInterval)
	the potential sweep element constructor. More...

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

AisDCPotentialSweepElement &	operator= (const AisDCPotentialSweepElement &)
	overload equal to operator for the AisDCPotentialSweepElement 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	getStartingPot () const
	get the value set for the starting potential. More...

void	setStartingPot (double startingPotential)
	set the value for the starting potential. More...

bool	isStartVoltageVsOCP () const
	tells whether the starting potential is set against the open-circuit voltage or the reference terminal. More...

void	setStartVoltageVsOCP (bool startVoltageVsOCP)
	set whether to reference the starting potential against the open-circuit voltage or the reference terminal. More...

double	getEndingPot () const
	get the value set for the ending potential value. More...

void	setEndingPot (double endingPotential)
	set the ending potential value. More...

bool	isEndVoltageVsOCP () const
	tells whether the end voltage is set with respect to the open circuit voltage or the reference terminal. More...

void	setEndVoltageVsOCP (bool endVoltageVsOCP)
	set whether to reference the end voltage against the open-circuit voltage or the reference terminal. More...

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

void	setScanRate (double scanRate)
	set the value for the voltage 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...

bool	isAutoRange () const
	tells whether the current range is set to auto-select or not. More...

void	setAutoRange ()
	set to auto-select the current range. More...

double	getApproxMaxCurrent () const
	get the value set for the expected maximum current. More...

void	setApproxMaxCurrent (double approxMaxCurrent)
	set maximum current expected, for manual current range selection. More...

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

void	setMaxAbsoluteCurrent (double maxCurrent)
	set a maximum Current to stop the experiment. More...

double	getMinAbsoluteCurrent () const
	get the value set minimum for the Current in amps. More...

void	setMinAbsoluteCurrent (double minCurrent)
	set a minimum Current 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 potential sweep from the starting current to the ending current which progresses linearly according to the scan rate.

Constructor & Destructor Documentation

◆ AisDCPotentialSweepElement()

AisDCPotentialSweepElement::AisDCPotentialSweepElement	(	double	startPotential,
		double	endPotential,
		double	scanRate,
		double	samplingInterval
	)

explicit

the potential sweep element constructor.

Parameters

startPotential	the value of the starting potential in volts
endPotential	the value of the ending potential in volts
scanRate	the voltage scan rate in V/s
samplingInterval	how frequently we are sampling the data.

Member Function Documentation

◆ getAlphaFactor()

double AisDCPotentialSweepElement::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.

◆ getApproxMaxCurrent()

double AisDCPotentialSweepElement::getApproxMaxCurrent ( ) const

get the value set for the expected maximum current.

Returns: the value set for the expected maximum current in Amps.

Note: if nothing was manually set, the device will auto-select the current range and the return value will be positive infinity.

◆ getCategory()

QStringList AisDCPotentialSweepElement::getCategory ( ) const

override

get a list of applicable categories of the element.

Returns: A list of applicable categories: ("Potentiostatic Control", "Basic Experiments").

◆ getEndingPot()

double AisDCPotentialSweepElement::getEndingPot ( ) const

get the value set for the ending potential value.

This is the value of the voltage at which the experiment will stop.

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

◆ getMaxAbsoluteCurrent()

double AisDCPotentialSweepElement::getMaxAbsoluteCurrent ( ) const

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

Returns: the value set for the maximum Current.

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

◆ getMinAbsoluteCurrent()

double AisDCPotentialSweepElement::getMinAbsoluteCurrent ( ) const

get the value set minimum for the Current in amps.

Returns: the value set for the minimum Current in amps.

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

◆ getName()

QString AisDCPotentialSweepElement::getName ( ) const

override

get the name of the element.

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

◆ getQuietTime()

double AisDCPotentialSweepElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns: The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisDCPotentialSweepElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

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

◆ getSamplingInterval()

double AisDCPotentialSweepElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ getScanRate()

double AisDCPotentialSweepElement::getScanRate ( ) const

get the value set for the voltage scan rate.

Returns: the value set for the voltage scan rate in V/s

See also: setScanRate

◆ getStartingPot()

double AisDCPotentialSweepElement::getStartingPot ( ) const

get the value set for the starting potential.

Returns: the value of the starting potential in volts.

◆ isAutoRange()

bool AisDCPotentialSweepElement::isAutoRange ( ) const

tells whether the current range is set to auto-select or not.

Returns: true if the current range is set to auto-select and false if a rage has been selected.

◆ isEndVoltageVsOCP()

bool AisDCPotentialSweepElement::isEndVoltageVsOCP ( ) const

tells whether the end voltage is set with respect to the open circuit voltage or the reference terminal.

Returns: true if the end voltage is set with respect to the open-circuit voltage and false if set against the reference terminal.

See also: setEndVoltageVsOCP

◆ isStartVoltageVsOCP()

bool AisDCPotentialSweepElement::isStartVoltageVsOCP ( ) const

tells whether the starting potential is set against the open-circuit voltage or the reference terminal.

Returns: true if the starting potential is set against the open-circuit voltage and false if it is set against the reference terminal.

See also: setStartVoltageVsOCP

◆ setAlphaFactor()

void AisDCPotentialSweepElement::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.

◆ setApproxMaxCurrent()

void AisDCPotentialSweepElement::setApproxMaxCurrent ( double approxMaxCurrent )

set maximum current expected, for manual current range selection.

This is an optional parameter. If nothing is set, the device will auto-select the current range.

Parameters

approxMaxCurrent the value for the maximum current expected in Amps.

◆ setAutoRange()

void AisDCPotentialSweepElement::setAutoRange ( )

set to auto-select the current range.

This option is set by default. There is no need to call this function to auto-select if the range was not manually set.

◆ setEndingPot()

void AisDCPotentialSweepElement::setEndingPot ( double endingPotential )

set the ending potential value.

This is the value of the voltage at which the experiment will stop.

Parameters

endingPotential the value to set for the ending potential in volts.

◆ setEndVoltageVsOCP()

void AisDCPotentialSweepElement::setEndVoltageVsOCP ( bool endVoltageVsOCP )

set whether to reference the end voltage against the open-circuit voltage or the reference terminal.

The reference terminal is for you to connect to any reference point you like. Connect it to the working electrode to reference ground.

Parameters

endVoltageVsOCP true to set the end voltage to be referenced against the open-circuit voltage and false if set against the reference terminal.

Note: by default, this is set to false.

◆ setMaxAbsoluteCurrent()

void AisDCPotentialSweepElement::setMaxAbsoluteCurrent ( double maxCurrent )

set a maximum Current to stop the experiment.

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

Parameters

maxCurrent the maximum Current value in volts at which the experiment will stop.

◆ setMinAbsoluteCurrent()

void AisDCPotentialSweepElement::setMinAbsoluteCurrent ( double minCurrent )

set a minimum Current to stop the experiment.

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

Parameters

minCurrent the minimum Current value in volts at which the experiment will stop.

◆ setQuietTime()

void AisDCPotentialSweepElement::setQuietTime ( double quietTime )

Sets the quiet time duration.

Parameters

quietTime The quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisDCPotentialSweepElement::setQuietTimeSamplingInterval ( double quietTimeSamplingInterval )

Sets the quiet time sampling interval.

Parameters

quietTimeSamplingInterval The quiet time sampling interval to set in seconds.

◆ setSamplingInterval()

void AisDCPotentialSweepElement::setSamplingInterval ( double samplingInterval )

set how frequently we are sampling the data.

Parameters

samplingInterval the data sampling interval value in seconds.

◆ setScanRate()

void AisDCPotentialSweepElement::setScanRate ( double scanRate )

set the value for the voltage scan rate.

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

Parameters

scanRate the value to set for the scan rate.

◆ setStartingPot()

void AisDCPotentialSweepElement::setStartingPot ( double startingPotential )

set the value for the starting potential.

Parameters

startingPotential the value of the starting potential in volts

◆ setStartVoltageVsOCP()

void AisDCPotentialSweepElement::setStartVoltageVsOCP ( bool startVoltageVsOCP )

set whether to reference the starting potential against the open-circuit voltage or the reference terminal.

The reference terminal is for you to connect to any reference point you like. Connect it to the working electrode to reference ground.

Parameters

startVoltageVsOCP true to if the starting potential is set to reference the open-circuit voltage and false if set against the reference terminal.

Note: by default, this is set to false.

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

AisDCPotentialSweepElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisDCPotentialSweepElement()

Member Function Documentation

◆ getAlphaFactor()

◆ getApproxMaxCurrent()

◆ getCategory()

◆ getEndingPot()

◆ getMaxAbsoluteCurrent()

◆ getMinAbsoluteCurrent()

◆ getName()

◆ getQuietTime()

◆ getQuietTimeSamplingInterval()

◆ getSamplingInterval()

◆ getScanRate()

◆ getStartingPot()

◆ isAutoRange()

◆ isEndVoltageVsOCP()

◆ isStartVoltageVsOCP()

◆ setAlphaFactor()

◆ setApproxMaxCurrent()

◆ setAutoRange()

◆ setEndingPot()

◆ setEndVoltageVsOCP()

◆ setMaxAbsoluteCurrent()

◆ setMinAbsoluteCurrent()

◆ setQuietTime()

◆ setQuietTimeSamplingInterval()

◆ setSamplingInterval()

◆ setScanRate()

◆ setStartingPot()

◆ setStartVoltageVsOCP()