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
28class SQUIDSTATLIBRARY_EXPORT AisSquareWaveVoltammetryElement final : public AisAbstractElement {
29public:
39 [[deprecated("Use the constructor with the approxMaxCurrent parameter instead.")]]
41 double startVoltage,
42 double endVoltage,
43 double voltageStep,
44 double pulseAmp,
45 double pulseFrequency);
46
57 double startVoltage,
58 double endVoltage,
59 double voltageStep,
60 double pulseAmp,
61 double pulseFrequency,
62 double approxMaxCurrent);
63
72
74
79 QString getName() const override;
80
85 QStringList getCategory() const override;
86
91 double getQuietTime() const;
92
97 void setQuietTime(double quietTime);
98
104
109 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
110
115 double getStartVoltage() const;
116
121 void setStartVoltage(double startVoltage);
122
130
138 void setStartVoltageVsOCP(bool startVoltageVsOcp);
139
146 double getEndVoltage() const;
147
154 void setEndVoltage(double endVoltage);
155
161 bool isEndVoltageVsOCP() const;
162
170 void setEndVoltageVsOCP(bool endVoltageVsOcp);
171
177 double getVStep() const;
178
185 void setVStep(double vStep);
186
192 double getPulseAmp() const;
193
201 void setPulseAmp(double pulseAmp);
202
207 double getPulseFreq() const;
208
213 void setPulseFreq(double pulseFreq);
214
222 [[deprecated("No longer supports auto range for this element. Specify the current using setApproxMaxCurrent(). The device will determine the appropriate range based on the current value.")]]
223 bool isAutoRange() const;
224
232 [[deprecated("Specify the current using setApproxMaxCurrent(). The device will determine the appropriate range based on the current value.")]]
234
240 double getApproxMaxCurrent() const;
241
249 void setApproxMaxCurrent(double approxMaxCurrent);
250
257 double getAlphaFactor() const;
258
266 void setAlphaFactor(double alphaFactor);
267
268private:
269 std::shared_ptr<SquareWaveVoltammetryElement> m_dataDerived;
270};
This experiment holds the working electrode at the starting potential during the quiet time....
Definition AisSquareWaveVoltammetryElement.h:28
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.
AisSquareWaveVoltammetryElement(double startVoltage, double endVoltage, double voltageStep, double pulseAmp, double pulseFrequency, double approxMaxCurrent)
the square wave element constructor
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.