![]() |
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>
#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. | |
|
explicit |
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. |
|
explicit |
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. |
double AisSquareWaveVoltammetryElement::getAlphaFactor | ( | ) | const |
double AisSquareWaveVoltammetryElement::getApproxMaxCurrent | ( | ) | const |
|
override |
double AisSquareWaveVoltammetryElement::getEndVoltage | ( | ) | const |
This is the value of the voltage at which the experiment will stop.
|
override |
double AisSquareWaveVoltammetryElement::getPulseAmp | ( | ) | const |
double AisSquareWaveVoltammetryElement::getPulseFreq | ( | ) | const |
double AisSquareWaveVoltammetryElement::getQuietTime | ( | ) | const |
double AisSquareWaveVoltammetryElement::getQuietTimeSamplingInterval | ( | ) | const |
double AisSquareWaveVoltammetryElement::getStartVoltage | ( | ) | const |
double AisSquareWaveVoltammetryElement::getVStep | ( | ) | const |
bool AisSquareWaveVoltammetryElement::isAutoRange | ( | ) | const |
bool AisSquareWaveVoltammetryElement::isEndVoltageVsOCP | ( | ) | const |
bool AisSquareWaveVoltammetryElement::isStartVoltageVsOCP | ( | ) | const |
void AisSquareWaveVoltammetryElement::setAlphaFactor | ( | double | alphaFactor | ) |
This is an optional parameter. If nothing is set, the device will use the default value of 75.
alphaFactor | the value for the alphaFactor ranges from 0 to 100. |
void AisSquareWaveVoltammetryElement::setApproxMaxCurrent | ( | double | approxMaxCurrent | ) |
This is an optional parameter. If nothing is set, the device will auto-select the current range.
approxMaxCurrent | the value for the maximum current expected in Amps. |
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.
void AisSquareWaveVoltammetryElement::setEndVoltage | ( | double | endVoltage | ) |
This is the value of the voltage at which the experiment will stop.
endVoltage | the value to set for the ending potential in volts. |
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.
endVoltageVsOcp | true to set the end voltage to be referenced against the open-circuit voltage and false if set against the reference terminal. |
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).
pulseAmp | the value to set for the pulse amplitude in volts. |
void AisSquareWaveVoltammetryElement::setPulseFreq | ( | double | pulseFreq | ) |
pulseFreq | the value to set for the pulse frequency in Hz. |
void AisSquareWaveVoltammetryElement::setQuietTime | ( | double | quietTime | ) |
quietTime | The quiet time duration to set in seconds. |
void AisSquareWaveVoltammetryElement::setQuietTimeSamplingInterval | ( | double | quietTimeSamplingInterval | ) |
quietTimeSamplingInterval | The quiet time sampling interval to set in seconds. |
void AisSquareWaveVoltammetryElement::setStartVoltage | ( | double | startVoltage | ) |
startVoltage | the value of the start voltage in volts |
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.
startVoltageVsOcp | true to if the start voltage is set to reference the open-circuit voltage and false if set against the reference terminal. |
void AisSquareWaveVoltammetryElement::setVStep | ( | double | vStep | ) |
vStep | the value for the voltage step in volts. |