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
20class SQUIDSTATLIBRARY_EXPORT AisDCPotentialSweepElement final : public AisAbstractElement {
21public:
30 double startPotential,
31 double endPotential,
32 double scanRate,
33 double samplingInterval);
42
44
49 QString getName() const override;
50
55 QStringList getCategory() const override;
56
61 double getQuietTime() const;
62
67 void setQuietTime(double quietTime);
68
74
79 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
80
85 double getStartingPot() const;
86
91 void setStartingPot(double startingPotential);
92
98 bool isStartVoltageVsOCP() const;
99
107 void setStartVoltageVsOCP(bool startVoltageVsOCP);
108
115 double getEndingPot() const;
116
123 void setEndingPot(double endingPotential);
124
130 bool isEndVoltageVsOCP() const;
131
139 void setEndVoltageVsOCP(bool endVoltageVsOCP);
140
146 double getScanRate() const;
147
154 void setScanRate(double scanRate);
155
160 double getSamplingInterval() const;
161
166 void setSamplingInterval(double samplingInterval);
167
172 bool isAutoRange() const;
173
180
186 double getApproxMaxCurrent() const;
187
195 void setApproxMaxCurrent(double approxMaxCurrent);
196
197
204 double getMaxAbsoluteCurrent() const;
205
214 void setMaxAbsoluteCurrent(double maxCurrent);
215
221 double getMinAbsoluteCurrent() const;
222
231 void setMinAbsoluteCurrent(double minCurrent);
232
239 double getAlphaFactor() const;
240
248 void setAlphaFactor(double alphaFactor);
249
250private:
251 std::shared_ptr<DCPotentialSweepElement> m_dataDerived;
252};
this experiment performs a DC potential sweep from the starting current to the ending current which p...
Definition AisDCPotentialSweepElement.h:20
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.