AisEISPotentiostaticElement Class Reference

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>

#include <AisEISPotentiostaticElement.h>

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

Constructor & Destructor Documentation

AisEISPotentiostaticElement()

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

explicit

Parameters

startFrequency	the value for the voltage starting frequency
endFrequency	the value for the voltage ending frequency
stepsPerDecade	the value for the voltage frequency steps per decade.
voltageBias	the value for the DC bias (DC offset).
voltageAmplitude	the AC voltage amplitude.

Member Function Documentation

getAmplitude()

double AisEISPotentiostaticElement::getAmplitude

(

)

const

Returns

the value set for the AC voltage amplitude in volts.

getBiasVoltage()

double AisEISPotentiostaticElement::getBiasVoltage

(

)

const

Returns

the value set for the DC bias in volts.

getCategory()

QStringList AisEISPotentiostaticElement::getCategory ( ) const

override

Returns

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

getEndFreq()

double AisEISPotentiostaticElement::getEndFreq

(

)

const

Returns

the value set for the voltage end frequency in Hz

getMinimumCycles()

unsigned int AisEISPotentiostaticElement::getMinimumCycles

(

)

const

Returns

get number of cycles to sample at each frequency.

getName()

QString AisEISPotentiostaticElement::getName ( ) const

override

Returns

The name of the element: "Potentiostatic EIS".

getQuietTime()

double AisEISPotentiostaticElement::getQuietTime

(

)

const

Returns

The quiet time duration in seconds.

getQuietTimeSamplingInterval()

double AisEISPotentiostaticElement::getQuietTimeSamplingInterval

(

)

const

Returns

samplingInterval The quiet time sampling interval to set in seconds.

getStartFreq()

double AisEISPotentiostaticElement::getStartFreq

(

)

const

Returns

the value set for the start frequency in Hz

getStepsPerDecade()

double AisEISPotentiostaticElement::getStepsPerDecade

(

)

const

Returns

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

isBiasVoltageVsOCP()

bool AisEISPotentiostaticElement::isBiasVoltageVsOCP

(

)

const

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

)

Parameters

amplitude

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

setBiasVoltage()

void AisEISPotentiostaticElement::setBiasVoltage

(

double

biasVoltage

)

Parameters

biasVoltage

the value to set for the DC bias in volts.

setBiasVoltageVsOCP()

void AisEISPotentiostaticElement::setBiasVoltageVsOCP

(

bool

biasVsOCP

)

Parameters

biasVsOCP

true 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

)

Parameters

endFreq

the value to set for the voltage end frequency in Hz

setMinimumCycles()

void AisEISPotentiostaticElement::setMinimumCycles

(

unsigned int

numberOfCycle

)

Parameters

numberOfCycle

number of cycles to sample at each frequency.

setQuietTime()

void AisEISPotentiostaticElement::setQuietTime

(

double

quietTime

)

Parameters

quietTime

The quiet time duration to set in seconds.

setQuietTimeSamplingInterval()

void AisEISPotentiostaticElement::setQuietTimeSamplingInterval

(

double

quietTimeSamplingInterval

)

Parameters

quietTimeSamplingInterval

The quiet time sampling interval to set in seconds.

setStartFreq()

void AisEISPotentiostaticElement::setStartFreq

(

double

startFreq

)

Parameters

startFreq

the value to set the starting frequency Hz

setStepsPerDecade()

void AisEISPotentiostaticElement::setStepsPerDecade

(

double

stepsPerDecade

)

Parameters

stepsPerDecade

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

---

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

• AisEISPotentiostaticElement.h