Squidstat API User Manual
Loading...
Searching...
No Matches
AisSquareWaveVoltammetryElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class SquareWaveVoltammetryElement;
8
25class SQUIDSTATLIBRARY_EXPORT AisSquareWaveVoltammetryElement final : public AisAbstractElement {
26public:
36 double startVoltage,
37 double endVoltage,
38 double voltageStep,
39 double pulseAmp,
40 double pulseFrequency);
41
50
52
57 QString getName() const override;
58
63 QStringList getCategory() const override;
64
69 double getQuietTime() const;
70
75 void setQuietTime(double quietTime);
76
82
87 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
88
93 double getStartVoltage() const;
94
99 void setStartVoltage(double startVoltage);
100
108
116 void setStartVoltageVsOCP(bool startVoltageVsOcp);
117
124 double getEndVoltage() const;
125
132 void setEndVoltage(double endVoltage);
133
139 bool isEndVoltageVsOCP() const;
140
148 void setEndVoltageVsOCP(bool endVoltageVsOcp);
149
155 double getVStep() const;
156
163 void setVStep(double vStep);
164
170 double getPulseAmp() const;
171
179 void setPulseAmp(double pulseAmp);
180
185 double getPulseFreq() const;
186
191 void setPulseFreq(double pulseFreq);
192
197 bool isAutoRange() const;
198
205
211 double getApproxMaxCurrent() const;
212
220 void setApproxMaxCurrent(double approxMaxCurrent);
221
228 double getAlphaFactor() const;
229
237 void setAlphaFactor(double alphaFactor);
238
239private:
240 std::shared_ptr<SquareWaveVoltammetryElement> m_dataDerived;
241};
This experiment holds the working electrode at the starting potential during the quiet time....
Definition: AisSquareWaveVoltammetryElement.h:25
void setStartVoltage(double startVoltage)
set the value for the start voltage.
void setAutoRange()
set to auto-select the current range.
bool isStartVoltageVsOCP() const
tells whether the start voltage is set against the open-circuit voltage or the reference terminal.
double getEndVoltage() const
get the value set for the ending potential value.
bool isAutoRange() const
tells whether the current range is set to auto-select or not.
double getPulseFreq() const
get the value set for the pulse frequency.
void setEndVoltageVsOCP(bool endVoltageVsOcp)
set whether to reference the end voltage against the open-circuit voltage or the reference terminal.
double getStartVoltage() const
get the value set for the start voltage.
void setPulseFreq(double pulseFreq)
set the value for the pulse frequency.
QString getName() const override
get the name of the element.
void setVStep(double vStep)
set the value for the voltage step. The voltage step is added to the value of the starting potential ...
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
void setPulseAmp(double pulseAmp)
set the value for the pulse amplitude.
void setQuietTime(double quietTime)
Sets the quiet time duration.
void setApproxMaxCurrent(double approxMaxCurrent)
set maximum current expected, for manual current range selection.
double getApproxMaxCurrent() const
get the value set for the expected maximum current.
double getVStep() const
get the value set for the voltage step.
void setAlphaFactor(double alphaFactor)
alpha factor controls the percentage of data sampled during a given interval. Data will be averaged o...
double getPulseAmp() const
get the value set for the pulse amplitude.
double getAlphaFactor() const
Get the value set for the alpha factor.
double getQuietTime() const
Gets the quiet time duration.
void setStartVoltageVsOCP(bool startVoltageVsOcp)
set whether to reference the start voltage against the open-circuit voltage or the reference terminal...
AisSquareWaveVoltammetryElement(double startVoltage, double endVoltage, double voltageStep, double pulseAmp, double pulseFrequency)
the square wave element constructor
double getQuietTimeSamplingInterval() const
gets the quiet time sampling interval.
AisSquareWaveVoltammetryElement & operator=(const AisSquareWaveVoltammetryElement &)
overload equal to operator for the AisSquareWaveVoltammetryElement object.
AisSquareWaveVoltammetryElement(const AisSquareWaveVoltammetryElement &)
copy constructor for the AisSquareWaveVoltammetryElement object.
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 termin...
QStringList getCategory() const override
get a list of applicable categories of the element.