This experiment holds the working electrode at the starting potential during the quiet time. Then it applies a train of square pulses superimposed on a staircase waveform with a uniform potential step magnitude. More...

#include <AisSquareWaveVoltammetryElement.h>

Public Member Functions
	AisSquareWaveVoltammetryElement (double startVoltage, double endVoltage, double voltageStep, double pulseAmp, double pulseFrequency)
	the square wave element constructor

	AisSquareWaveVoltammetryElement (double startVoltage, double endVoltage, double voltageStep, double pulseAmp, double pulseFrequency, double approxMaxCurrent)
	the square wave element constructor

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

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

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

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

double	getQuietTime () const
	Gets the quiet time duration.

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

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

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

double	getStartVoltage () const
	get the value set for the start voltage.

void	setStartVoltage (double startVoltage)
	set the value for the start voltage.

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

void	setStartVoltageVsOCP (bool startVoltageVsOcp)
	set whether to reference the start voltage against the open-circuit voltage or the reference terminal.

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

void	setEndVoltage (double endVoltage)
	set the ending potential value.

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

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

double	getVStep () const
	get the value set for the voltage step.

void	setVStep (double vStep)
	set the value for the voltage step. The voltage step is added to the value of the starting potential of the previous pulse to start the new pulse.

double	getPulseAmp () const
	get the value set for the pulse amplitude.

void	setPulseAmp (double pulseAmp)
	set the value for the pulse amplitude.

double	getPulseFreq () const
	get the value set for the pulse frequency.

void	setPulseFreq (double pulseFreq)
	set the value for the pulse frequency.

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

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

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

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

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

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.

Constructor & Destructor Documentation

◆ AisSquareWaveVoltammetryElement() [1/2]

AisSquareWaveVoltammetryElement::AisSquareWaveVoltammetryElement	(	double	startVoltage,
		double	endVoltage,
		double	voltageStep,
		double	pulseAmp,
		double	pulseFrequency )

explicit

Parameters

startVoltage	the value of the starting potential in volts
endVoltage	the value of the ending potential in volts
voltageStep	the value set for the voltage step in volts.
pulseAmp	the value for the pulse amplitude in volts.
pulseFrequency	the value for the pulse frequency in Hz.

Deprecated: Use the constructor with the approxMaxCurrent parameter instead.

◆ AisSquareWaveVoltammetryElement() [2/2]

AisSquareWaveVoltammetryElement::AisSquareWaveVoltammetryElement	(	double	startVoltage,
		double	endVoltage,
		double	voltageStep,
		double	pulseAmp,
		double	pulseFrequency,
		double	approxMaxCurrent )

explicit

Parameters

startVoltage	the value of the starting potential in volts
endVoltage	the value of the ending potential in volts
voltageStep	the value set for the voltage step in volts.
pulseAmp	the value for the pulse amplitude in volts.
pulseFrequency	the value for the pulse frequency in Hz.
approxMaxCurrent	the value for the approximate maximum current in amperes.

Member Function Documentation

◆ getAlphaFactor()

double AisSquareWaveVoltammetryElement::getAlphaFactor ( ) const

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 AisSquareWaveVoltammetryElement::getApproxMaxCurrent ( ) const

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 AisSquareWaveVoltammetryElement::getCategory ( ) const

override

Returns: A list of applicable categories: ("Potentiostatic Control", "Pulse Voltammetry").

◆ getEndVoltage()

double AisSquareWaveVoltammetryElement::getEndVoltage ( ) const

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

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

◆ getName()

QString AisSquareWaveVoltammetryElement::getName ( ) const

override

Returns: The name of the element: "Square Wave Potential Voltammetry".

◆ getPulseAmp()

double AisSquareWaveVoltammetryElement::getPulseAmp ( ) const

Returns: the value set for the pulse amplitude in volts.

See also: setPulseAmp

◆ getPulseFreq()

double AisSquareWaveVoltammetryElement::getPulseFreq ( ) const

Returns: the value set for the frequency in Hz.

◆ getQuietTime()

double AisSquareWaveVoltammetryElement::getQuietTime ( ) const

Returns: The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisSquareWaveVoltammetryElement::getQuietTimeSamplingInterval ( ) const

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

◆ getStartVoltage()

double AisSquareWaveVoltammetryElement::getStartVoltage ( ) const

Returns: the value of the start voltage in volts.

◆ getVStep()

double AisSquareWaveVoltammetryElement::getVStep ( ) const

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

See also: setVStep

◆ isAutoRange()

bool AisSquareWaveVoltammetryElement::isAutoRange ( ) const

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

Deprecated: This function is deprecated and no longer supports auto range for this element. Specify the current using setApproxMaxCurrent(). The device will determine the appropriate range based on the current value.

◆ isEndVoltageVsOCP()

bool AisSquareWaveVoltammetryElement::isEndVoltageVsOCP ( ) const

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

Note: if nothing is set, the default is false.

◆ isStartVoltageVsOCP()

bool AisSquareWaveVoltammetryElement::isStartVoltageVsOCP ( ) const

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

Note: if nothing is set, the default is false.

See also: setStartVoltageVsOCP

◆ setAlphaFactor()

void AisSquareWaveVoltammetryElement::setAlphaFactor ( double alphaFactor )

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 AisSquareWaveVoltammetryElement::setApproxMaxCurrent ( double approxMaxCurrent )

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 AisSquareWaveVoltammetryElement::setAutoRange ( )

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

Deprecated: This function is deprecated. Use setApproxMaxCurrent() to specify the current range instead.

◆ setEndVoltage()

void AisSquareWaveVoltammetryElement::setEndVoltage ( double endVoltage )

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

Parameters

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

◆ setEndVoltageVsOCP()

void AisSquareWaveVoltammetryElement::setEndVoltageVsOCP ( bool endVoltageVsOcp )

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.

◆ setPulseAmp()

void AisSquareWaveVoltammetryElement::setPulseAmp ( double pulseAmp )

The voltage pulse goes up in hight by the given amplitude in addition to the starting potential (of the previous pulse). It then goes back down twice the amplitude to end up one amplitude below the starting potential (of the previous pulse).

Parameters

pulseAmp the value to set for the pulse amplitude in volts.

◆ setPulseFreq()

void AisSquareWaveVoltammetryElement::setPulseFreq ( double pulseFreq )

Parameters

pulseFreq the value to set for the pulse frequency in Hz.

◆ setQuietTime()

void AisSquareWaveVoltammetryElement::setQuietTime ( double quietTime )

Parameters

quietTime The quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisSquareWaveVoltammetryElement::setQuietTimeSamplingInterval ( double quietTimeSamplingInterval )

Parameters

quietTimeSamplingInterval The quiet time sampling interval to set in seconds.

◆ setStartVoltage()

void AisSquareWaveVoltammetryElement::setStartVoltage ( double startVoltage )

Parameters

startVoltage the value of the start voltage in volts

◆ setStartVoltageVsOCP()

void AisSquareWaveVoltammetryElement::setStartVoltageVsOCP ( bool startVoltageVsOcp )

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 start voltage is set to reference the open-circuit voltage and false if set against the reference terminal.

Note: by default, this is set to false.

◆ setVStep()

void AisSquareWaveVoltammetryElement::setVStep ( double vStep )

Parameters

vStep the value for the voltage step in volts.

Note: Regardless of vStep's sign, the device will determine the step direction based on the start and end voltage.

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

AisSquareWaveVoltammetryElement.h

Public Member Functions

Constructor & Destructor Documentation

◆ AisSquareWaveVoltammetryElement() [1/2]

◆ AisSquareWaveVoltammetryElement() [2/2]

Member Function Documentation

◆ getAlphaFactor()

◆ getApproxMaxCurrent()

◆ getCategory()

◆ getEndVoltage()

◆ getName()

◆ getPulseAmp()

◆ getPulseFreq()

◆ getQuietTime()

◆ getQuietTimeSamplingInterval()

◆ getStartVoltage()

◆ getVStep()

◆ isAutoRange()

◆ isEndVoltageVsOCP()

◆ isStartVoltageVsOCP()

◆ setAlphaFactor()

◆ setApproxMaxCurrent()

◆ setAutoRange()

◆ setEndVoltage()

◆ setEndVoltageVsOCP()

◆ setPulseAmp()

◆ setPulseFreq()

◆ setQuietTime()

◆ setQuietTimeSamplingInterval()

◆ setStartVoltage()

◆ setStartVoltageVsOCP()

◆ setVStep()