Loading...
Searching...
No Matches
AisNormalPulseVoltammetryElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class NormalPulseVoltammetryElement;
8
26class SQUIDSTATLIBRARY_EXPORT AisNormalPulseVoltammetryElement final : public AisAbstractElement {
27public:
36 [[deprecated("Use the constructor with the approxMaxCurrent parameter instead.")]]
38 double startVoltage,
39 double endVoltage,
40 double voltageStep,
41 double pulseWidth,
42 double pulsePeriod);
43
44
55 double startVoltage,
56 double endVoltage,
57 double voltageStep,
58 double pulseWidth,
59 double pulsePeriod,
60 double approxMaxCurrent);
61
70
72
77 QString getName() const override;
78
83 QStringList getCategory() const override;
84
89 double getQuietTime() const;
90
95 void setQuietTime(double quietTime);
96
102
107 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
108
113 double getStartVoltage() const;
114
119 void setStartVoltage(double startVoltage);
120
128
136 void setStartVoltageVsOCP(bool startVoltageVsOCP);
137
144 double getEndVoltage() const;
145
152 void setEndVoltage(double endVoltage);
153
159 bool isEndVoltageVsOCP() const;
160
168 void setEndVoltageVsOCP(bool endVoltageVsOcp);
169
175 double getVStep() const;
176
184 void setVStep(double vStep);
185
192 double getPulseWidth() const;
193
200 void setPulseWidth(double pulseWidth);
201
207 double getPulsePeriod() const;
208
215 void setPulsePeriod(double pulsePeriod);
216
224 [[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.")]]
225 bool isAutoRange() const;
226
234 [[deprecated("Specify the current using setApproxMaxCurrent(). The device will determine the appropriate range based on the current value.")]]
236
242 double getApproxMaxCurrent() const;
243
251 void setApproxMaxCurrent(double approxMaxCurrent);
252
259 double getAlphaFactor() const;
260
268 void setAlphaFactor(double alphaFactor);
269
270private:
271 std::shared_ptr<NormalPulseVoltammetryElement> m_dataDerived;
272};
This experiment holds the working electrode at a baseline potential during the quiet time,...
Definition AisNormalPulseVoltammetryElement.h:26
void setAlphaFactor(double alphaFactor)
alpha factor controls the percentage of data sampled during a given interval. Data will be averaged o...
AisNormalPulseVoltammetryElement(const AisNormalPulseVoltammetryElement &)
copy constructor for the AisNormalPulseVoltammetryElement object.
void setApproxMaxCurrent(double approxMaxCurrent)
set maximum current expected, for manual current range selection.
QStringList getCategory() const override
get a list of applicable categories of the element.
void setAutoRange()
set to auto-select the current range.
AisNormalPulseVoltammetryElement(double startVoltage, double endVoltage, double voltageStep, double pulseWidth, double pulsePeriod, double approxMaxCurrent)
the normal-pulse-voltammetry element constructor
bool isEndVoltageVsOCP() const
tells whether the end voltage is set with respect to the open circuit voltage or the reference termin...
bool isAutoRange() const
tells whether the current range is set to auto-select or not.
double getStartVoltage() const
get the value set for the start voltage.
double getApproxMaxCurrent() const
get the value set for the expected maximum current.
void setPulseWidth(double pulseWidth)
set the value in seconds for pulse width.
bool isStartVoltageVsOCP() const
tells whether the start voltage is set against the open-circuit voltage or the reference terminal.
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
AisNormalPulseVoltammetryElement(double startVoltage, double endVoltage, double voltageStep, double pulseWidth, double pulsePeriod)
the normal-pulse-voltammetry element constructor
double getEndVoltage() const
get the value set for the ending potential value.
void setEndVoltage(double endVoltage)
set the ending potential value.
void setQuietTime(double quietTime)
Sets the quiet time duration.
double getPulseWidth() const
get the value set for the pulse width
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...
double getQuietTimeSamplingInterval() const
gets the quiet time sampling interval.
void setEndVoltageVsOCP(bool endVoltageVsOcp)
set whether to reference the end voltage against the open-circuit voltage or the reference terminal.
QString getName() const override
get the name of the element.
double getPulsePeriod() const
get the value set for the pulse period.
AisNormalPulseVoltammetryElement & operator=(const AisNormalPulseVoltammetryElement &)
overload equal to operator for the AisNormalPulseVoltammetryElement object.
void setVStep(double vStep)
set the value for the voltage step.
void setStartVoltage(double startVoltage)
set the value for the start voltage.
void setPulsePeriod(double pulsePeriod)
set the value for the pulse period.
double getAlphaFactor() const
Get the value set for the alpha factor.
double getVStep() const
get the value set for the voltage step.