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

This experiment records the complex impedance of the experimental cell in potentiostatic mode, starting from the start frequency and sweeping through towards the end frequency, with a fixed number of frequency steps per decade. More...

#include <AisEISPotentiostaticElement.h>

Inherits AisAbstractElement.

Public Member Functions

 AisEISPotentiostaticElement (double startFrequency, double endFrequency, double stepsPerDecade, double voltageBias, double voltageAmplitude)
 the EIS potentiostatic element More...
 
 AisEISPotentiostaticElement (const AisEISPotentiostaticElement &)
 copy constructor for the AisEISPotentiostaticElement object.
 
AisEISPotentiostaticElementoperator= (const AisEISPotentiostaticElement &)
 overload equal to operator for the AisEISPotentiostaticElement 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 getStartFreq () const
 get the value set for the voltage starting frequency More...
 
void setStartFreq (double startFreq)
 set the value for the voltage starting frequency. More...
 
double getEndFreq () const
 the value set for the voltage ending frequency. More...
 
void setEndFreq (double endFreq)
 set the value for the voltage end frequency. More...
 
double getStepsPerDecade () const
 get the value set for the voltage frequency steps per decade. More...
 
void setStepsPerDecade (double stepsPerDecade)
 set the number of the voltage frequency steps per decade. More...
 
double getBiasVoltage () const
 get the value set for the DC bias (DC offset). More...
 
void setBiasVoltage (double biasVoltage)
 set the value for the DC bias (DC offset). More...
 
bool isBiasVoltageVsOCP () const
 tells whether the DC-bias voltage is referenced against the open-circuit voltage or the reference cable. More...
 
void setBiasVoltageVsOCP (bool biasVsOCP)
 set whether to reference the DC-bias voltage against the open-circuit voltage or the reference terminal. More...
 
double getAmplitude () const
 the value to set for the AC voltage amplitude. More...
 
void setAmplitude (double amplitude)
 set the value for the AC voltage amplitude. More...
 
unsigned int getMinimumCycles () const
 get the minimum number of periods of applied sinusoidal voltage to sample at each frequency. More...
 
void setMinimumCycles (unsigned int numberOfCycle)
 set the minimum number of periods of applied sinusoidal voltage to sample at each frequency. More...
 

Detailed Description

This experiment records the complex impedance of the experimental cell in potentiostatic mode, starting from the start frequency and sweeping through towards the end frequency, with a fixed number of frequency steps per decade.

Important parameters include the DC bias and the AC excitation amplitude.


Constructor & Destructor Documentation

◆ AisEISPotentiostaticElement()

AisEISPotentiostaticElement::AisEISPotentiostaticElement ( double  startFrequency,
double  endFrequency,
double  stepsPerDecade,
double  voltageBias,
double  voltageAmplitude 
)
explicit

the EIS potentiostatic element

Parameters
startFrequencythe value for the voltage starting frequency
endFrequencythe value for the voltage ending frequency
stepsPerDecadethe value for the voltage frequency steps per decade.
voltageBiasthe value for the DC bias (DC offset).
voltageAmplitudethe AC voltage amplitude.

Member Function Documentation

◆ getAmplitude()

double AisEISPotentiostaticElement::getAmplitude ( ) const

the value to set for the AC voltage amplitude.

Returns
the value set for the AC voltage amplitude in volts.

◆ getBiasVoltage()

double AisEISPotentiostaticElement::getBiasVoltage ( ) const

get the value set for the DC bias (DC offset).

Returns
the value set for the DC bias in volts.

◆ getCategory()

QStringList AisEISPotentiostaticElement::getCategory ( ) const
override

get a list of applicable categories of the element.

Returns
A list of applicable categories: ("Potentiostatic Control", "Impedance Methods", "Basic Experiments").

◆ getEndFreq()

double AisEISPotentiostaticElement::getEndFreq ( ) const

the value set for the voltage ending frequency.

Returns
the value set for the voltage end frequency in Hz

◆ getMinimumCycles()

unsigned int AisEISPotentiostaticElement::getMinimumCycles ( ) const

get the minimum number of periods of applied sinusoidal voltage to sample at each frequency.

Returns
get number of cycles to sample at each frequency.

◆ getName()

QString AisEISPotentiostaticElement::getName ( ) const
override

get the name of the element.

Returns
The name of the element: "Potentiostatic EIS".

◆ getQuietTime()

double AisEISPotentiostaticElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns
The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisEISPotentiostaticElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

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

◆ getStartFreq()

double AisEISPotentiostaticElement::getStartFreq ( ) const

get the value set for the voltage starting frequency

Returns
the value set for the start frequency in Hz

◆ getStepsPerDecade()

double AisEISPotentiostaticElement::getStepsPerDecade ( ) const

get the value set for the voltage frequency steps per decade.

Returns
the value set for the frequency steps per decade. This is unit-less.

◆ isBiasVoltageVsOCP()

bool AisEISPotentiostaticElement::isBiasVoltageVsOCP ( ) const

tells whether the DC-bias voltage is referenced against the open-circuit voltage or the reference cable.

The reference terminal is for you to connect to any reference point you like. Connect it to the working electrode to reference ground.

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

◆ setAmplitude()

void AisEISPotentiostaticElement::setAmplitude ( double  amplitude)

set the value for the AC voltage amplitude.

Parameters
amplitudethe value to set for the AC voltage amplitude in volts.

◆ setBiasVoltage()

void AisEISPotentiostaticElement::setBiasVoltage ( double  biasVoltage)

set the value for the DC bias (DC offset).

Parameters
biasVoltagethe value to set for the DC bias in volts.

◆ setBiasVoltageVsOCP()

void AisEISPotentiostaticElement::setBiasVoltageVsOCP ( bool  biasVsOCP)

set whether to reference the DC-bias voltage against the open-circuit voltage or the reference terminal.

Parameters
biasVsOCPtrue to if the DC-bias voltage is set to reference the open-circuit voltage and false if set against the reference terminal.

◆ setEndFreq()

void AisEISPotentiostaticElement::setEndFreq ( double  endFreq)

set the value for the voltage end frequency.

Parameters
endFreqthe value to set for the voltage end frequency in Hz

◆ setMinimumCycles()

void AisEISPotentiostaticElement::setMinimumCycles ( unsigned int  numberOfCycle)

set the minimum number of periods of applied sinusoidal voltage to sample at each frequency.

Parameters
numberOfCyclenumber of cycles to sample at each frequency.

◆ setQuietTime()

void AisEISPotentiostaticElement::setQuietTime ( double  quietTime)

Sets the quiet time duration.

Parameters
quietTimeThe quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisEISPotentiostaticElement::setQuietTimeSamplingInterval ( double  quietTimeSamplingInterval)

Sets the quiet time sampling interval.

Parameters
quietTimeSamplingIntervalThe quiet time sampling interval to set in seconds.

◆ setStartFreq()

void AisEISPotentiostaticElement::setStartFreq ( double  startFreq)

set the value for the voltage starting frequency.

Parameters
startFreqthe value to set the starting frequency Hz

◆ setStepsPerDecade()

void AisEISPotentiostaticElement::setStepsPerDecade ( double  stepsPerDecade)

set the number of the voltage frequency steps per decade.

Parameters
stepsPerDecadethe value to set for the number of steps per decade.

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