Squidstat API User Manual
Loading...
Searching...
No Matches
AisDiffPulseVoltammetryElement Class Referencefinal

In this experiment, the working electrode holds at a starting potential during the quiet time. Then it applies a train of pulses superimposed on a staircase waveform, with a uniform potential step size. The potential continues to step until the final potential is reached. More...

#include <AisDiffPulseVoltammetryElement.h>

Inherits AisAbstractElement.

Public Member Functions

 AisDiffPulseVoltammetryElement (double startVoltage, double endVoltage, double voltageStep, double pulseHeight, double pulseWidth, double pulsePeriod)
 the differential pulse element constructor. More...
 
 AisDiffPulseVoltammetryElement (const AisDiffPulseVoltammetryElement &)
 copy constructor for the AisDiffPulseVoltammetryElement object.
 
AisDiffPulseVoltammetryElementoperator= (const AisDiffPulseVoltammetryElement &)
 overload equal to operator for the AisDiffPulseVoltammetryElement 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 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 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 potential step. More...
 
void setVStep (double vStep)
 set the value for the potential step. More...
 
double getPulseHeight () const
 get the value set for the pulse height. More...
 
void setPulseHeight (double pulseHeight)
 set the value for the pulse height. More...
 
double getPulseWidth () const
 get the value set for the pulse width. More...
 
void setPulseWidth (double pulseWidth)
 set the value for the 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

In this experiment, the working electrode holds at a starting potential during the quiet time. Then it applies a train of pulses superimposed on a staircase waveform, with a uniform potential step size. The potential continues to step until the final potential is reached.

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

◆ AisDiffPulseVoltammetryElement()

AisDiffPulseVoltammetryElement::AisDiffPulseVoltammetryElement ( double  startVoltage,
double  endVoltage,
double  voltageStep,
double  pulseHeight,
double  pulseWidth,
double  pulsePeriod 
)
explicit

the differential pulse element constructor.

Parameters
startVoltagethe value of the starting potential in volts
endVoltagethe value of the ending potential in volts
voltageStepthe value set for the voltage step in volts.
pulseHeightthe value for the pulse height in volts.
pulseWidththe value for the pulse width in seconds.
pulsePeriodthe value for the pulse period in seconds.

Member Function Documentation

◆ getAlphaFactor()

double AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::getName ( ) const
override

get the name of the element.

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

◆ getPulseHeight()

double AisDiffPulseVoltammetryElement::getPulseHeight ( ) const

get the value set for the pulse height.

Returns
the value set for the pulse height in volts.
See also
setPulseHeight

◆ getPulsePeriod()

double AisDiffPulseVoltammetryElement::getPulsePeriod ( ) const

get the value set for the pulse period.

Returns
the value set for the pulse period in seconds.
See also
setPulsePeriod

◆ getPulseWidth()

double AisDiffPulseVoltammetryElement::getPulseWidth ( ) const

get the value set for the pulse width.

Returns
the value set for the pulse width in seconds.
See also
setPulseWidth

◆ getQuietTime()

double AisDiffPulseVoltammetryElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns
The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisDiffPulseVoltammetryElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

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

◆ getStartVoltage()

double AisDiffPulseVoltammetryElement::getStartVoltage ( ) const

get the value set for the start voltage.

Returns
the value of the start voltage in volts.

◆ getVStep()

double AisDiffPulseVoltammetryElement::getVStep ( ) const

get the value set for the potential step.

Returns
the value set for the potential step in volts.
See also
setVStep

◆ isAutoRange()

bool AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::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
alphaFactorthe value for the alphaFactor ranges from 0 to 100.

◆ setApproxMaxCurrent()

void AisDiffPulseVoltammetryElement::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
approxMaxCurrentthe value for the maximum current expected in Amps.

◆ setAutoRange()

void AisDiffPulseVoltammetryElement::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 AisDiffPulseVoltammetryElement::setEndVoltage ( double  endVoltage)

set the ending potential value.

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

Parameters
endVoltagethe value to set for the ending voltage in volts.

◆ setEndVoltageVsOCP()

void AisDiffPulseVoltammetryElement::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
endVoltageVsOCPtrue 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.

◆ setPulseHeight()

void AisDiffPulseVoltammetryElement::setPulseHeight ( double  pulseHeight)

set the value for the pulse height.

For the first pulse, the pulse height is added to the starting potential. For the next pulse, the pulse height is added to the potential voltage and the potential step. In general, the pulse height is added to the potential step and the starting voltage of the last pulse.

Parameters
pulseHeightthe value to set for the pulse height in volts.

◆ setPulsePeriod()

void AisDiffPulseVoltammetryElement::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
pulsePeriodthe value to set for the pulse period in seconds.

◆ setPulseWidth()

void AisDiffPulseVoltammetryElement::setPulseWidth ( double  pulseWidth)

set the value for the pulse width.

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

Parameters
pulseWidththe value to set for the pulse width in seconds.
See also
setPulseHeight

◆ setQuietTime()

void AisDiffPulseVoltammetryElement::setQuietTime ( double  quietTime)

Sets the quiet time duration.

Parameters
quietTimeThe quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisDiffPulseVoltammetryElement::setQuietTimeSamplingInterval ( double  quietTimeSamplingInterval)

Sets the quiet time sampling interval.

Parameters
quietTimeSamplingIntervalThe quiet time sampling interval to set in seconds.

◆ setStartVoltage()

void AisDiffPulseVoltammetryElement::setStartVoltage ( double  startVoltage)

set the value for the start voltage.

Parameters
startVoltagethe value of the start voltage in volts

◆ setStartVoltageVsOCP()

void AisDiffPulseVoltammetryElement::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
startVoltageVsOCPtrue 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.

◆ setVStep()

void AisDiffPulseVoltammetryElement::setVStep ( double  vStep)

set the value for the potential step.

The potential step is the difference between the starting potential of two consecutive pulses.

Parameters
vStepthe value to set for the potential 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: