This experiment holds the working electrode at a baseline potential during the quiet time, then applies a train of pulses, which increase in amplitude until the final potential is reached. More...

#include <AisNormalPulseVoltammetryElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisNormalPulseVoltammetryElement (double startVoltage, double endVoltage, double voltageStep, double pulseWidth, double pulsePeriod)
	the normal-pulse-voltammetry element constructor More...

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

AisNormalPulseVoltammetryElement &	operator= (const AisNormalPulseVoltammetryElement &)
	overload equal to operator for the AisNormalPulseVoltammetryElement 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	getStartVoltage () const
	get the value set for the start voltage. More...

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

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

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

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

void	setEndVoltage (double endVoltage)
	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	getVStep () const
	get the value set for the voltage step. More...

void	setVStep (double vStep)
	set the value for the voltage step. More...

double	getPulseWidth () const
	get the value set for the pulse width More...

void	setPulseWidth (double pulseWidth)
	set the value in seconds for pulse width. More...

double	getPulsePeriod () const
	get the value set for the pulse period. More...

void	setPulsePeriod (double pulsePeriod)
	set the value for the pulse period. 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	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 holds the working electrode at a baseline potential during the quiet time, then applies a train of pulses, which increase in amplitude until the final potential is reached.

The potential step is the magnitude of this incremental increase. The pulse width is the amount of time between the rising and falling edge of a pulse. The pulse period is the amount of time between the beginning of one pulse and the beginning of the next.

Advanced control of data output for pulse experiments can be performed using the class

See also: AisDataManipulator

Constructor & Destructor Documentation

◆ AisNormalPulseVoltammetryElement()

AisNormalPulseVoltammetryElement::AisNormalPulseVoltammetryElement	(	double	startVoltage,
		double	endVoltage,
		double	voltageStep,
		double	pulseWidth,
		double	pulsePeriod
	)

explicit

the normal-pulse-voltammetry element constructor

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.
pulseWidth	the value for the pulse width in seconds.
pulsePeriod	the value for the pulse period in seconds.

Member Function Documentation

◆ getAlphaFactor()

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

override

get a list of applicable categories of the element.

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

◆ getEndVoltage()

double AisNormalPulseVoltammetryElement::getEndVoltage ( ) 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.

◆ getName()

QString AisNormalPulseVoltammetryElement::getName ( ) const

override

get the name of the element.

Returns: The name of the element: "Normal Pulse Potential Voltammetry".

◆ getPulsePeriod()

double AisNormalPulseVoltammetryElement::getPulsePeriod ( ) const

get the value set for the pulse period.

Returns: the value for the pulse period in seconds.

See also: setPulsePeriod

◆ getPulseWidth()

double AisNormalPulseVoltammetryElement::getPulseWidth ( ) const

get the value set for the pulse width

Returns: the value of the pulse width in seconds.

See also: setPulseWidth

◆ getQuietTime()

double AisNormalPulseVoltammetryElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns: The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisNormalPulseVoltammetryElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

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

◆ getStartVoltage()

double AisNormalPulseVoltammetryElement::getStartVoltage ( ) const

get the value set for the start voltage.

Returns: the value of the start voltage in volts.

◆ getVStep()

double AisNormalPulseVoltammetryElement::getVStep ( ) const

get the value set for the voltage step.

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

See also: setVStep

◆ isAutoRange()

bool AisNormalPulseVoltammetryElement::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 AisNormalPulseVoltammetryElement::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.

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

◆ isStartVoltageVsOCP()

bool AisNormalPulseVoltammetryElement::isStartVoltageVsOCP ( ) const

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

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 AisNormalPulseVoltammetryElement::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 AisNormalPulseVoltammetryElement::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 AisNormalPulseVoltammetryElement::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.

◆ setEndVoltage()

void AisNormalPulseVoltammetryElement::setEndVoltage ( double endVoltage )

set the ending potential value.

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 AisNormalPulseVoltammetryElement::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.

◆ setPulsePeriod()

void AisNormalPulseVoltammetryElement::setPulsePeriod ( double pulsePeriod )

set the value for the pulse period.

The pulse period is the time spent between the starts of two consecutive pulses.

Parameters

pulsePeriod the value to set for the pulse period in seconds.

◆ setPulseWidth()

void AisNormalPulseVoltammetryElement::setPulseWidth ( double pulseWidth )

set the value in seconds for pulse width.

The pulse width is the value in seconds for the time spent at the same voltage set for the pulse height.

Parameters

pulseWidth the value to set for the pulse width in seconds.

◆ setQuietTime()

void AisNormalPulseVoltammetryElement::setQuietTime ( double quietTime )

Sets the quiet time duration.

Parameters

quietTime The quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisNormalPulseVoltammetryElement::setQuietTimeSamplingInterval ( double quietTimeSamplingInterval )

Sets the quiet time sampling interval.

Parameters

quietTimeSamplingInterval The quiet time sampling interval to set in seconds.

◆ setStartVoltage()

void AisNormalPulseVoltammetryElement::setStartVoltage ( double startVoltage )

set the value for the start voltage.

Parameters

startVoltage the value of the start voltage in volts

◆ setStartVoltageVsOCP()

void AisNormalPulseVoltammetryElement::setStartVoltageVsOCP ( bool startVoltageVsOCP )

set whether to reference the start 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

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 AisNormalPulseVoltammetryElement::setVStep ( double vStep )

set the value for the voltage step.

The voltage step is the voltage difference between the heights of two consecutive pulses.

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:

AisNormalPulseVoltammetryElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisNormalPulseVoltammetryElement()

Member Function Documentation

◆ getAlphaFactor()

◆ getApproxMaxCurrent()

◆ getCategory()

◆ getEndVoltage()

◆ getName()

◆ getPulsePeriod()

◆ getPulseWidth()

◆ getQuietTime()

◆ getQuietTimeSamplingInterval()

◆ getStartVoltage()

◆ getVStep()

◆ isAutoRange()

◆ isEndVoltageVsOCP()

◆ isStartVoltageVsOCP()

◆ setAlphaFactor()

◆ setApproxMaxCurrent()

◆ setAutoRange()

◆ setEndVoltage()

◆ setEndVoltageVsOCP()

◆ setPulsePeriod()

◆ setPulseWidth()

◆ setQuietTime()

◆ setQuietTimeSamplingInterval()

◆ setStartVoltage()

◆ setStartVoltageVsOCP()

◆ setVStep()