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

This class performs Mott-Schottky analysis on the working electrode for a specified range of potentials. More...

#include <AisMottSchottkyElement.h>

Inherits AisAbstractElement.

Public Member Functions

 AisMottSchottkyElement (double startingPotential, double endingPotential, double voltageStep, double startFrequency, double endFrequency, double stepsPerDecade, double amplitude, unsigned int minCycles)
 Constructor for the Mott-Schottky experiment element. More...
 
 AisMottSchottkyElement (const AisMottSchottkyElement &other)
 Copy constructor for the AisMottSchottkyElement object. More...
 
AisMottSchottkyElementoperator= (const AisMottSchottkyElement &other)
 Assignment operator for the AisMottSchottkyElement object. More...
 
 ~AisMottSchottkyElement () override
 Destructor for the AisMottSchottkyElement object.
 
QString getName () const override
 Get the name of the experiment element. More...
 
QStringList getCategory () const override
 Get a list of applicable categories of the experiment element. More...
 
double getStartingPotential () const
 Get the starting potential for the experiment. More...
 
void setStartingPotential (double startingPotential)
 Set the starting potential for the experiment. More...
 
double getEndingPotential () const
 Get the ending potential for the experiment. More...
 
void setEndingPotential (double endingPotential)
 Set the ending potential for the experiment. More...
 
double getVoltageStep () const
 Get the voltage step size between each potential. More...
 
void setVoltageStep (double voltageStep)
 Set the voltage step size between each potential. More...
 
double getStartFrequency () const
 Get the starting frequency for the EIS measurement. More...
 
void setStartFrequency (double startFrequency)
 Set the starting frequency for the EIS measurement. More...
 
double getEndFrequency () const
 Get the ending frequency for the EIS measurement. More...
 
void setEndFrequency (double endFrequency)
 Set the ending frequency for the EIS measurement. More...
 
double getStepsPerDecade () const
 Get the number of frequency steps per decade. More...
 
void setStepsPerDecade (double stepsPerDecade)
 Set the number of frequency steps per decade. More...
 
double getAmplitude () const
 Get the amplitude of the AC signal used in the EIS measurement. More...
 
void setAmplitude (double amplitude)
 Set the amplitude of the AC signal used in the EIS measurement. More...
 
unsigned int getMinCycles () const
 Get the minimum number of cycles per frequency step. More...
 
void setMinCycles (unsigned int minCycles)
 Set the minimum number of cycles per frequency step. More...
 
double getQuietTime () const
 Get the quiet time before starting the EIS measurement. More...
 
void setQuietTime (double quietTime)
 Set the quiet time before starting the EIS measurement. More...
 
double getQuietTimeSampInterval () const
 Get the sampling interval during the quiet time. More...
 
void setQuietTimeSampInterval (double quietTimeSampInterval)
 Set the sampling interval during the quiet time. More...
 
double getStepQuietTime () const
 Get the quiet time after each potential step before starting the EIS measurement. More...
 
void setStepQuietTime (double stepQuietTime)
 Set the quiet time after each potential step before starting the EIS measurement. More...
 
double getStepQuietSampInterval () const
 Get the sampling interval during the quiet time after each potential step. More...
 
void setStepQuietSampInterval (double stepQuietTimeSampInterval)
 Set the sampling interval during the quiet time after each potential step. More...
 
bool isStartVoltageVsOCP () const
 Check if the starting voltage is measured versus the open circuit potential (OCP). More...
 
void setStartVoltageVsOCP (bool startVsOCP)
 Set whether the starting voltage is measured versus the open circuit potential (OCP). More...
 
bool isEndVoltageVsOCP () const
 Check if the ending voltage is measured versus the open circuit potential (OCP). More...
 
void setEndVoltageVsOCP (bool endVsOCP)
 Set whether the ending voltage is measured versus the open circuit potential (OCP). More...
 

Detailed Description

This class performs Mott-Schottky analysis on the working electrode for a specified range of potentials.

The Mott-Schottky experiment is used to analyze the electrochemical properties of a working electrode by sweeping the potential from a starting potential to an ending potential in discrete steps. At each potential step, Electrochemical Impedance Spectroscopy (EIS) is performed with varying frequencies to gather impedance data.

The experiment can be configured with various parameters, including the starting and ending potentials, voltage step size, starting and ending frequencies, steps per frequency decade, AC excitation amplitude, and the minimum number of cycles per frequency.

Note
The potential sweep is done in a staircase manner, with each step consisting of a quiet time followed by an EIS measurement.


Constructor & Destructor Documentation

◆ AisMottSchottkyElement() [1/2]

AisMottSchottkyElement::AisMottSchottkyElement ( double  startingPotential,
double  endingPotential,
double  voltageStep,
double  startFrequency,
double  endFrequency,
double  stepsPerDecade,
double  amplitude,
unsigned int  minCycles 
)
explicit

Constructor for the Mott-Schottky experiment element.

Parameters
startingPotentialThe starting potential (voltage) for the experiment.
endingPotentialThe ending potential (voltage) for the experiment.
voltageStepThe voltage step size between each potential during the experiment.
startFrequencyThe starting frequency for the EIS measurement.
endFrequencyThe ending frequency for the EIS measurement.
stepsPerDecadeThe number of frequency steps per decade.
amplitudeThe amplitude of the AC signal used in the EIS measurement.
minCyclesThe minimum number of cycles per frequency step during the EIS measurement.

◆ AisMottSchottkyElement() [2/2]

AisMottSchottkyElement::AisMottSchottkyElement ( const AisMottSchottkyElement other)
explicit

Copy constructor for the AisMottSchottkyElement object.

Parameters
otherThe object to copy from.

Member Function Documentation

◆ getAmplitude()

double AisMottSchottkyElement::getAmplitude ( ) const

Get the amplitude of the AC signal used in the EIS measurement.

Returns
The AC amplitude in volts.

◆ getCategory()

QStringList AisMottSchottkyElement::getCategory ( ) const
override

Get a list of applicable categories of the experiment element.

Returns
A list of categories where the experiment is applicable, such as "Advanced Experiments".

◆ getEndFrequency()

double AisMottSchottkyElement::getEndFrequency ( ) const

Get the ending frequency for the EIS measurement.

Returns
The ending frequency in Hz.

◆ getEndingPotential()

double AisMottSchottkyElement::getEndingPotential ( ) const

Get the ending potential for the experiment.

Returns
The ending potential in volts.

◆ getMinCycles()

unsigned int AisMottSchottkyElement::getMinCycles ( ) const

Get the minimum number of cycles per frequency step.

Returns
The minimum number of cycles.

◆ getName()

QString AisMottSchottkyElement::getName ( ) const
override

Get the name of the experiment element.

Returns
The name of the element, "Mott-Schottky".

◆ getQuietTime()

double AisMottSchottkyElement::getQuietTime ( ) const

Get the quiet time before starting the EIS measurement.

Returns
The quiet time in seconds.

◆ getQuietTimeSampInterval()

double AisMottSchottkyElement::getQuietTimeSampInterval ( ) const

Get the sampling interval during the quiet time.

Returns
The sampling interval in seconds.

◆ getStartFrequency()

double AisMottSchottkyElement::getStartFrequency ( ) const

Get the starting frequency for the EIS measurement.

Returns
The starting frequency in Hz.

◆ getStartingPotential()

double AisMottSchottkyElement::getStartingPotential ( ) const

Get the starting potential for the experiment.

Returns
The starting potential in volts.

◆ getStepQuietSampInterval()

double AisMottSchottkyElement::getStepQuietSampInterval ( ) const

Get the sampling interval during the quiet time after each potential step.

Returns
The sampling interval in seconds.

◆ getStepQuietTime()

double AisMottSchottkyElement::getStepQuietTime ( ) const

Get the quiet time after each potential step before starting the EIS measurement.

Returns
The quiet time after each potential step in seconds.

◆ getStepsPerDecade()

double AisMottSchottkyElement::getStepsPerDecade ( ) const

Get the number of frequency steps per decade.

Returns
The number of steps per decade.

◆ getVoltageStep()

double AisMottSchottkyElement::getVoltageStep ( ) const

Get the voltage step size between each potential.

Returns
The voltage step size in volts.

◆ isEndVoltageVsOCP()

bool AisMottSchottkyElement::isEndVoltageVsOCP ( ) const

Check if the ending voltage is measured versus the open circuit potential (OCP).

Returns
True if the ending voltage is measured versus OCP, false otherwise.

◆ isStartVoltageVsOCP()

bool AisMottSchottkyElement::isStartVoltageVsOCP ( ) const

Check if the starting voltage is measured versus the open circuit potential (OCP).

Returns
True if the starting voltage is measured versus OCP, false otherwise.

◆ operator=()

AisMottSchottkyElement & AisMottSchottkyElement::operator= ( const AisMottSchottkyElement other)

Assignment operator for the AisMottSchottkyElement object.

Parameters
otherThe object to assign from.
Returns
A reference to the assigned object.

◆ setAmplitude()

void AisMottSchottkyElement::setAmplitude ( double  amplitude)

Set the amplitude of the AC signal used in the EIS measurement.

Parameters
amplitudeThe AC amplitude in volts.

◆ setEndFrequency()

void AisMottSchottkyElement::setEndFrequency ( double  endFrequency)

Set the ending frequency for the EIS measurement.

Parameters
endFrequencyThe ending frequency in Hz.

◆ setEndingPotential()

void AisMottSchottkyElement::setEndingPotential ( double  endingPotential)

Set the ending potential for the experiment.

Parameters
endingPotentialThe ending potential in volts.

◆ setEndVoltageVsOCP()

void AisMottSchottkyElement::setEndVoltageVsOCP ( bool  endVsOCP)

Set whether the ending voltage is measured versus the open circuit potential (OCP).

Parameters
endVsOCPTrue if the ending voltage is measured versus OCP, false otherwise.

◆ setMinCycles()

void AisMottSchottkyElement::setMinCycles ( unsigned int  minCycles)

Set the minimum number of cycles per frequency step.

Parameters
minCyclesThe minimum number of cycles.

◆ setQuietTime()

void AisMottSchottkyElement::setQuietTime ( double  quietTime)

Set the quiet time before starting the EIS measurement.

Parameters
quietTimeThe quiet time in seconds.

◆ setQuietTimeSampInterval()

void AisMottSchottkyElement::setQuietTimeSampInterval ( double  quietTimeSampInterval)

Set the sampling interval during the quiet time.

Parameters
quietTimeSampIntervalThe sampling interval in seconds.

◆ setStartFrequency()

void AisMottSchottkyElement::setStartFrequency ( double  startFrequency)

Set the starting frequency for the EIS measurement.

Parameters
startFrequencyThe starting frequency in Hz.

◆ setStartingPotential()

void AisMottSchottkyElement::setStartingPotential ( double  startingPotential)

Set the starting potential for the experiment.

Parameters
startingPotentialThe starting potential in volts.

◆ setStartVoltageVsOCP()

void AisMottSchottkyElement::setStartVoltageVsOCP ( bool  startVsOCP)

Set whether the starting voltage is measured versus the open circuit potential (OCP).

Parameters
startVsOCPTrue if the starting voltage is measured versus OCP, false otherwise.

◆ setStepQuietSampInterval()

void AisMottSchottkyElement::setStepQuietSampInterval ( double  stepQuietTimeSampInterval)

Set the sampling interval during the quiet time after each potential step.

Parameters
stepQuietTimeSampIntervalThe sampling interval in seconds.

◆ setStepQuietTime()

void AisMottSchottkyElement::setStepQuietTime ( double  stepQuietTime)

Set the quiet time after each potential step before starting the EIS measurement.

Parameters
stepQuietTimeThe quiet time after each potential step in seconds.

◆ setStepsPerDecade()

void AisMottSchottkyElement::setStepsPerDecade ( double  stepsPerDecade)

Set the number of frequency steps per decade.

Parameters
stepsPerDecadeThe number of steps per decade.

◆ setVoltageStep()

void AisMottSchottkyElement::setVoltageStep ( double  voltageStep)

Set the voltage step size between each potential.

Parameters
voltageStepThe voltage step size in volts.

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