Squidstat API User Manual
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
23class SQUIDSTATLIBRARY_EXPORT AisNormalPulseVoltammetryElement final : public AisAbstractElement {
24public:
34 double startVoltage,
35 double endVoltage,
36 double voltageStep,
37 double pulseWidth,
38 double pulsePeriod);
47
49
54 QString getName() const override;
55
60 QStringList getCategory() const override;
61
66 double getQuietTime() const;
67
72 void setQuietTime(double quietTime);
73
79
84 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
85
90 double getStartVoltage() const;
91
96 void setStartVoltage(double startVoltage);
97
105
113 void setStartVoltageVsOCP(bool startVoltageVsOCP);
114
121 double getEndVoltage() const;
122
129 void setEndVoltage(double endVoltage);
130
136 bool isEndVoltageVsOCP() const;
137
145 void setEndVoltageVsOCP(bool endVoltageVsOcp);
146
152 double getVStep() const;
153
161 void setVStep(double vStep);
162
169 double getPulseWidth() const;
170
177 void setPulseWidth(double pulseWidth);
178
184 double getPulsePeriod() const;
185
192 void setPulsePeriod(double pulsePeriod);
193
198 bool isAutoRange() const;
199
206
212 double getApproxMaxCurrent() const;
213
221 void setApproxMaxCurrent(double approxMaxCurrent);
222
229 double getAlphaFactor() const;
230
238 void setAlphaFactor(double alphaFactor);
239
240private:
241 std::shared_ptr<NormalPulseVoltammetryElement> m_dataDerived;
242};
This experiment holds the working electrode at a baseline potential during the quiet time,...
Definition: AisNormalPulseVoltammetryElement.h:23
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.
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.