Squidstat API User Manual
Loading...
Searching...
No Matches
AisEISPotentiostaticElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class EISPotentiostaticElement;
8
20class SQUIDSTATLIBRARY_EXPORT AisEISPotentiostaticElement final : public AisAbstractElement {
21public:
31 double startFrequency,
32 double endFrequency,
33 double stepsPerDecade,
34 double voltageBias,
35 double voltageAmplitude);
44
46
51 QString getName() const override;
52
57 QStringList getCategory() const override;
58
63 double getQuietTime() const;
64
69 void setQuietTime(double quietTime);
70
76
81 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
82
87 double getStartFreq() const;
88
93 void setStartFreq(double startFreq);
94
99 double getEndFreq() const;
100
105 void setEndFreq(double endFreq);
106
111 double getStepsPerDecade() const;
112
117 void setStepsPerDecade(double stepsPerDecade);
118
123 double getBiasVoltage() const;
124
129 void setBiasVoltage(double biasVoltage);
130
137 bool isBiasVoltageVsOCP() const;
138
143 void setBiasVoltageVsOCP(bool biasVsOCP);
144
149 double getAmplitude() const;
150
155 void setAmplitude(double amplitude);
156
161 unsigned int getMinimumCycles() const;
162
167 void setMinimumCycles(unsigned int numberOfCycle);
168
169private:
170 std::shared_ptr<EISPotentiostaticElement> m_dataDerived;
171};
This experiment records the complex impedance of the experimental cell in potentiostatic mode,...
Definition: AisEISPotentiostaticElement.h:20
bool isBiasVoltageVsOCP() const
tells whether the DC-bias voltage is referenced against the open-circuit voltage or the reference cab...
void setAmplitude(double amplitude)
set the value for the AC voltage amplitude.
AisEISPotentiostaticElement(double startFrequency, double endFrequency, double stepsPerDecade, double voltageBias, double voltageAmplitude)
the EIS potentiostatic element
void setMinimumCycles(unsigned int numberOfCycle)
set the minimum number of periods of applied sinusoidal voltage to sample at each frequency.
void setEndFreq(double endFreq)
set the value for the voltage end frequency.
double getBiasVoltage() const
get the value set for the DC bias (DC offset).
double getEndFreq() const
the value set for the voltage ending frequency.
unsigned int getMinimumCycles() const
get the minimum number of periods of applied sinusoidal voltage to sample at each frequency.
double getAmplitude() const
the value to set for the AC voltage amplitude.
QStringList getCategory() const override
get a list of applicable categories of the element.
double getStartFreq() const
get the value set for the voltage starting frequency
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
double getStepsPerDecade() const
get the value set for the voltage frequency steps per decade.
double getQuietTime() const
Gets the quiet time duration.
AisEISPotentiostaticElement(const AisEISPotentiostaticElement &)
copy constructor for the AisEISPotentiostaticElement object.
void setQuietTime(double quietTime)
Sets the quiet time duration.
QString getName() const override
get the name of the element.
void setStartFreq(double startFreq)
set the value for the voltage starting frequency.
void setBiasVoltageVsOCP(bool biasVsOCP)
set whether to reference the DC-bias voltage against the open-circuit voltage or the reference termin...
void setBiasVoltage(double biasVoltage)
set the value for the DC bias (DC offset).
AisEISPotentiostaticElement & operator=(const AisEISPotentiostaticElement &)
overload equal to operator for the AisEISPotentiostaticElement object.
double getQuietTimeSamplingInterval() const
gets the quiet time sampling interval.
void setStepsPerDecade(double stepsPerDecade)
set the number of the voltage frequency steps per decade.