Squidstat API User Manual
Loading...
Searching...
No Matches
AisStaircasePotentialVoltammetryElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class StaircasePotentialVoltammetryElement;
8
17class SQUIDSTATLIBRARY_EXPORT AisStaircasePotentialVoltammetryElement final : public AisAbstractElement {
18public:
30 double firstVoltageLimit,
31 double secondVoltageLimit,
32 double endVoltage,
33 double stepSize,
34 double stepDuration,
35 double samplingInterval);
36
42
49
54
59 QString getName() const override;
60
65 QStringList getCategory() const override;
66
71 double getQuietTime() const;
72
77 void setQuietTime(double quietTime);
78
84
89 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
90
95 double getStartVoltage() const;
96
101 void setStartVoltage(double startVoltage);
102
108
113 void setStartVoltageVsOCP(bool startVsOCP);
114
119 double getEndVoltage() const;
120
125 void setEndVoltage(double endVoltage);
126
131 bool isEndVoltageVsOCP() const;
132
137 void setEndVoltageVsOCP(bool endVsOCP);
138
143 double getFirstVoltageLimit() const;
144
149 void setFirstVoltageLimit(double firstVoltageLimit);
150
156
161 void setFirstVoltageLimitVsOCP(bool firstVoltageLimitVsOCP);
162
167 double getSecondVoltageLimit() const;
168
173 void setSecondVoltageLimit(double secondVoltageLimit);
174
180
185 void setSecondVoltageLimitVsOCP(bool secondVoltageLimitVsOCP);
186
191 double getStepSize() const;
192
197 void setStepSize(double stepSize);
198
203 double getStepDuration() const;
204
209 void setStepDuration(double stepDuration);
210
215 double getSamplingInterval() const;
216
221 void setSamplingInterval(double samplingInterval);
222
227 bool isAutorange() const;
228
233
238 double getApproxMaxCurrent() const;
239
244 void setApproxMaxCurrent(double approxMaxCurrent);
245
250 unsigned int getNumberOfCycles();
251
256 void setNumberOfCycles(unsigned int cycles);
257
258private:
259 std::shared_ptr<StaircasePotentialVoltammetryElement> m_dataDerived;
260};
AisStaircasePotentialVoltammetryElement class represents an element for staircase potential voltammet...
Definition: AisStaircasePotentialVoltammetryElement.h:17
void setAutorange()
Enables autorange for the experiment.
double getQuietTime() const
Gets the quiet time duration.
AisStaircasePotentialVoltammetryElement & operator=(const AisStaircasePotentialVoltammetryElement &other)
Assignment operator for AisStaircasePotentialVoltammetryElement.
bool isFirstVoltageLimitVsOCP() const
Checks if the first voltage limit is with respect to the open circuit mode.
AisStaircasePotentialVoltammetryElement(const AisStaircasePotentialVoltammetryElement &other)
Copy constructor for AisStaircasePotentialVoltammetryElement.
void setSecondVoltageLimit(double secondVoltageLimit)
Sets the second voltage limit.
double getSecondVoltageLimit() const
Gets the second voltage limit.
void setQuietTime(double quietTime)
Sets the quiet time duration.
bool isEndVoltageVsOCP() const
Checks if the ending voltage is with respect to the open circuit mode.
bool isSecondVoltageLimitVsOCP() const
Checks if the second voltage limit is with respect to the open circuit mode.
QStringList getCategory() const override
Gets the category of the element.
void setApproxMaxCurrent(double approxMaxCurrent)
Sets the approximate maximum current.
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
double getEndVoltage() const
Gets the ending voltage.
bool isStartVoltageVsOCP() const
Checks if the starting voltage is with respect to the open circuit mode.
AisStaircasePotentialVoltammetryElement(double startVoltage, double firstVoltageLimit, double secondVoltageLimit, double endVoltage, double stepSize, double stepDuration, double samplingInterval)
Constructs an AisStaircasePotentialVoltammetryElement with specified parameters.
double getStepSize() const
Gets the potential step size.
void setStepDuration(double stepDuration)
Sets the potential step duration.
void setSamplingInterval(double samplingInterval)
Sets the potential sampling interval.
void setEndVoltageVsOCP(bool endVsOCP)
Sets whether the ending voltage is with respect to the open circuit mode.
void setFirstVoltageLimitVsOCP(bool firstVoltageLimitVsOCP)
Sets whether the first voltage limit is with respect to the open circuit mode.
void setStartVoltageVsOCP(bool startVsOCP)
Sets whether the starting voltage is with respect to the open circuit mode.
double getQuietTimeSamplingInterval() const
gets the quiet time sampling interval.
void setSecondVoltageLimitVsOCP(bool secondVoltageLimitVsOCP)
Sets whether the second voltage limit is with respect to the open circuit mode.
unsigned int getNumberOfCycles()
get the value set for the number of cycles
void setNumberOfCycles(unsigned int cycles)
set the number of cycles to oscillate between the first voltage-limit and the second voltage-limit.
void setFirstVoltageLimit(double firstVoltageLimit)
Sets the first voltage limit.
void setEndVoltage(double endVoltage)
Sets the ending voltage.
void setStepSize(double stepSize)
Sets the potential step size.
~AisStaircasePotentialVoltammetryElement() override
Destructor for AisStaircasePotentialVoltammetryElement.
bool isAutorange() const
Checks if the experiment should autorange the current.
double getFirstVoltageLimit() const
Gets the first voltage limit.
double getApproxMaxCurrent() const
Gets the approximate maximum current.
QString getName() const override
Gets the name of the element.
void setStartVoltage(double startVoltage)
Sets the starting voltage.
double getStepDuration() const
Gets the potential step duration.
double getStartVoltage() const
Gets the starting voltage.
double getSamplingInterval() const
Gets the potential sampling interval.