Squidstat API User Manual
Loading...
Searching...
No Matches
AisCyclicVoltammetryElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class CyclicVoltammetryElement;
8
22class SQUIDSTATLIBRARY_EXPORT AisCyclicVoltammetryElement final : public AisAbstractElement {
23public:
34 double startVoltage,
35 double firstVoltageLimit,
36 double secondVoltageLimit,
37 double endVoltage,
38 double dEdt,
39 double samplingInterval);
40
45
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
106
113 void setStartVoltageVsOCP(bool startVoltageVsOCP);
114
122 double getFirstVoltageLimit() const;
123
131 void setFirstVoltageLimit(double v1);
132
139
146 void setFirstVoltageLimitVsOCP(bool firstVoltageLimitVsOCP);
147
155 double getSecondVoltageLimit() const;
156
164 void setSecondVoltageLimit(double v2);
165
172
179 void setSecondVoltageLimitVsOCP(bool secondVoltageLimitVsOCP);
180
185 unsigned int getNumberOfCycles();
186
191 void setNumberOfCycles(unsigned int cycles);
192
200 double getEndVoltage() const;
201
209 void setEndVoltage(double endVoltage);
210
216 bool isEndVoltageVsOCP() const;
217
224 void setEndVoltageVsOCP(bool endVoltageVsOCP);
225
230 double getdEdt() const;
231
236 void setdEdt(double dEdt);
237
242 double getSamplingInterval() const;
243
248 void setSamplingInterval(double sampInterval);
249
254 bool isAutoRange() const;
255
262
268 double getApproxMaxCurrent() const;
269
277 void setApproxMaxCurrent(double approxMaxCurrent);
278
285 double getAlphaFactor() const;
286
294 void setAlphaFactor(double alphaFactor);
295
296private:
297 std::shared_ptr<CyclicVoltammetryElement> m_dataDerived;
298};
This experiment sweeps the potential of the working electrode back and forth between the first voltag...
Definition: AisCyclicVoltammetryElement.h:22
AisCyclicVoltammetryElement & operator=(const AisCyclicVoltammetryElement &)
overload equal to operator for the AisCyclicVoltammetryElement object.
void setSecondVoltageLimit(double v2)
set the second voltage-limit
bool isSecondVoltageLimitVsOCP() const
tells whether the second voltage-limit is set with respect to the open circuit voltage or not.
void setAlphaFactor(double alphaFactor)
alpha factor controls the percentage of data sampled during a given interval. Data will be averaged o...
double getQuietTime() const
Gets the quiet time duration.
unsigned int getNumberOfCycles()
get the value set for the number of cycles
void setAutoRange()
set to auto-select the current range.
double getStartVoltage() const
get the value set for the start voltage
double getFirstVoltageLimit() const
get the value set for the first voltage-limit.
void setApproxMaxCurrent(double approxMaxCurrent)
set maximum current expected, for manual current range selection.
double getSecondVoltageLimit() const
get the value set for the second voltage-limit
bool isAutoRange() const
tells whether the current range is set to auto-select or not.
void setFirstVoltageLimit(double v1)
set the first voltage-limit
AisCyclicVoltammetryElement(const AisCyclicVoltammetryElement &)
copy constructor for the AisCyclicVoltammetryElement object.
AisCyclicVoltammetryElement(double startVoltage, double firstVoltageLimit, double secondVoltageLimit, double endVoltage, double dEdt, double samplingInterval)
constructor of the cyclic voltammetry element.
void setdEdt(double dEdt)
set the value for the constant scan rate dE/dt.
bool isEndVoltageVsOCP() const
tells whether the end voltage is set with respect to the open circuit voltage or the reference termin...
bool isFirstVoltageLimitVsOCP() const
tells whether the first voltage-limit is set with respect to the open circuit voltage or not.
void setEndVoltage(double endVoltage)
set the ending potential value.
double getEndVoltage() const
get the value set for the ending potential value.
void setSecondVoltageLimitVsOCP(bool secondVoltageLimitVsOCP)
set whether to reference the second voltage-limit against the open-circuit voltage or not.
double getAlphaFactor() const
Get the value set for the alpha factor.
double getQuietTimeSamplingInterval() const
gets the potential sampling interval.
void setQuietTime(double quietTime)
Sets the quiet time duration.
double getdEdt() const
get the value set for the constant scan rate dE/dt.
void setFirstVoltageLimitVsOCP(bool firstVoltageLimitVsOCP)
set whether to reference the first voltage-limit against the open-circuit voltage or not.
void setStartVoltage(double startVoltage)
set the value for the start voltage.
double getApproxMaxCurrent() const
get the value set for the expected maximum current.
QString getName() const override
get the name of the element.
double getSamplingInterval() const
get how frequently we are sampling the data.
bool isStartVoltageVsOCP() const
tells whether the start voltage is set with respect to the open circuit voltage or not.
void setEndVoltageVsOCP(bool endVoltageVsOCP)
set whether to reference the end voltage against the open-circuit voltage or the reference terminal.
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
void setStartVoltageVsOCP(bool startVoltageVsOCP)
set whether to reference the start voltage against the open-circuit voltage or the reference terminal...
void setSamplingInterval(double sampInterval)
set how frequently we are sampling the data.
void setNumberOfCycles(unsigned int cycles)
set the number of cycles to oscillate between the first voltage-limit and the second voltage-limit.
QStringList getCategory() const override
get a list of applicable categories of the element.