Squidstat API User Manual
Loading...
Searching...
No Matches
AisDCPotentialSweepElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class DCPotentialSweepElement;
8
17class SQUIDSTATLIBRARY_EXPORT AisDCPotentialSweepElement final : public AisAbstractElement {
18public:
27 double startPotential,
28 double endPotential,
29 double scanRate,
30 double samplingInterval);
39
41
46 QString getName() const override;
47
52 QStringList getCategory() const override;
53
58 double getQuietTime() const;
59
64 void setQuietTime(double quietTime);
65
71
76 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
77
82 double getStartingPot() const;
83
88 void setStartingPot(double startingPotential);
89
95 bool isStartVoltageVsOCP() const;
96
104 void setStartVoltageVsOCP(bool startVoltageVsOCP);
105
112 double getEndingPot() const;
113
120 void setEndingPot(double endingPotential);
121
127 bool isEndVoltageVsOCP() const;
128
136 void setEndVoltageVsOCP(bool endVoltageVsOCP);
137
143 double getScanRate() const;
144
151 void setScanRate(double scanRate);
152
157 double getSamplingInterval() const;
158
163 void setSamplingInterval(double samplingInterval);
164
169 bool isAutoRange() const;
170
177
183 double getApproxMaxCurrent() const;
184
192 void setApproxMaxCurrent(double approxMaxCurrent);
193
194
201 double getMaxAbsoluteCurrent() const;
202
211 void setMaxAbsoluteCurrent(double maxCurrent);
212
218 double getMinAbsoluteCurrent() const;
219
228 void setMinAbsoluteCurrent(double minCurrent);
229
236 double getAlphaFactor() const;
237
245 void setAlphaFactor(double alphaFactor);
246
247private:
248 std::shared_ptr<DCPotentialSweepElement> m_dataDerived;
249};
this experiment performs a DC potential sweep from the starting current to the ending current which p...
Definition: AisDCPotentialSweepElement.h:17
void setStartingPot(double startingPotential)
set the value for the starting potential.
double getMaxAbsoluteCurrent() const
get the value set for the maximum Current. The experiment will end when it reaches this value.
AisDCPotentialSweepElement(const AisDCPotentialSweepElement &)
copy constructor for the AisDCPotentialSweepElement object.
double getScanRate() const
get the value set for the voltage scan rate.
bool isAutoRange() const
tells whether the current range is set to auto-select or not.
bool isEndVoltageVsOCP() const
tells whether the end voltage is set with respect to the open circuit voltage or the reference termin...
void setEndingPot(double endingPotential)
set the ending potential value.
double getEndingPot() const
get the value set for the ending potential value.
AisDCPotentialSweepElement & operator=(const AisDCPotentialSweepElement &)
overload equal to operator for the AisDCPotentialSweepElement object.
void setMinAbsoluteCurrent(double minCurrent)
set a minimum Current to stop the experiment.
double getQuietTime() const
Gets the quiet time duration.
QStringList getCategory() const override
get a list of applicable categories of the element.
void setApproxMaxCurrent(double approxMaxCurrent)
set maximum current expected, for manual current range selection.
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.
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
void setAlphaFactor(double alphaFactor)
alpha factor controls the percentage of data sampled during a given interval. Data will be averaged o...
void setMaxAbsoluteCurrent(double maxCurrent)
set a maximum Current to stop the experiment.
double getApproxMaxCurrent() const
get the value set for the expected maximum current.
double getMinAbsoluteCurrent() const
get the value set minimum for the Current in amps.
double getAlphaFactor() const
Get the value set for the alpha factor.
bool isStartVoltageVsOCP() const
tells whether the starting potential is set against the open-circuit voltage or the reference termina...
double getSamplingInterval() const
get how frequently we are sampling the data.
AisDCPotentialSweepElement(double startPotential, double endPotential, double scanRate, double samplingInterval)
the potential sweep element constructor.
void setScanRate(double scanRate)
set the value for the voltage scan rate.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
void setQuietTime(double quietTime)
Sets the quiet time duration.
void setStartVoltageVsOCP(bool startVoltageVsOCP)
set whether to reference the starting potential against the open-circuit voltage or the reference ter...
void setAutoRange()
set to auto-select the current range.
double getStartingPot() const
get the value set for the starting potential.