Loading...
Searching...
No Matches
AisConstantPotElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class ConstantPotAdvElement;
8
18class SQUIDSTATLIBRARY_EXPORT AisConstantPotElement final : public AisAbstractElement {
19public:
27 double voltage,
28 double samplingInterval,
29 double duration);
34
39
40 ~AisConstantPotElement() override;
41
46 QString getName() const override;
47
52 QStringList getCategory() const override;
53
58 double getPotential() const;
59
64 void setPotential(double potential);
65
71 bool isVoltageVsOCP() const;
72
79 void setVoltageVsOCP(bool vsOCP);
80
85 double getSamplingInterval() const;
86
91 void setSamplingInterval(double samplingInterval);
92
98 double getMaxDuration() const;
99
108 void setMaxDuration(double maxDuration);
109
116 double getMaxAbsoluteCurrent() const;
117
126 void setMaxAbsoluteCurrent(double maxCurrent);
127
135 [[deprecated("getMaxCurrent has been renamed getMaxAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
136 double getMaxCurrent() const;
137
147 [[deprecated("setMaxCurrent has been renamed setMaxAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
148 void setMaxCurrent(double maxCurrent);
149
156 double getMinAbsoluteCurrent() const;
157
166 void setMinAbsoluteCurrent(double minCurrent);
167
175 [[deprecated("getMinCurrent has been renamed getMinAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
176 double getMinCurrent() const;
177
187 [[deprecated("setMinCurrent has been renamed setMinAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
188 void setMinCurrent(double minCurrent);
189
195 double getMaxCapacity() const;
196
205 void setMaxCapacity(double maxCapacity);
206
212 double getMindIdt() const;
213
222 void setMindIdt(double mindIdt);
223
228 bool isAutoRange() const;
229
236
242 double getApproxMaxCurrent() const;
243
251 void setApproxMaxCurrent(double approxMaxCurrent);
252
257 int getVoltageRange() const;
258
266 void setVoltageRange(int idx);
267
268private:
269 std::shared_ptr<ConstantPotAdvElement> m_dataDerived;
270};
an experiment that simulates a constant applied voltage.
Definition AisConstantPotElement.h:18
int getVoltageRange() const
get the value set for the voltage range.
void setAutoRange()
set to auto-select the current range.
AisConstantPotElement(double voltage, double samplingInterval, double duration)
the constant potential element constructor.
void setMinCurrent(double minCurrent)
set the minimum value for the absolute current in Amps.
void setMaxCurrent(double maxCurrent)
set the maximum value for the absolute current in Amps.
double getMaxAbsoluteCurrent() const
get the maximum value set for the absolute current in Amps. The experiment will end when the absolute...
AisConstantPotElement(const AisConstantPotElement &)
copy constructor for the AisConstantPotElement object.
double getMaxCurrent() const
get the maximum value set for the absolute current in Amps. The experiment will end when the absolute...
double getMinCurrent() const
get the minimum value set for the absolute current in Amps. The experiment will end when the absolute...
void setMaxAbsoluteCurrent(double maxCurrent)
set the maximum value for the absolute current in Amps.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
double getSamplingInterval() const
get how frequently we are sampling the data.
double getMindIdt() const
get the value set for the minimum current rate of change with respect to time (minimum di/dt).
bool isAutoRange() const
tells whether the current range is set to auto-select or not.
void setMinAbsoluteCurrent(double minCurrent)
set the minimum value for the absolute current in Amps.
void setVoltageRange(int idx)
manually set the voltage control range.
void setMaxDuration(double maxDuration)
set the maximum duration for the experiment.
void setMindIdt(double mindIdt)
set the minimum value for the current rate of change with respect to time (minimum di/dt).
bool isVoltageVsOCP() const
tells whether the specified voltage is set against the open-circuit voltage or the reference terminal...
QString getName() const override
get the name of the element.
AisConstantPotElement & operator=(const AisConstantPotElement &)
overload equal to operator for the AisConstantPotElement object.
QStringList getCategory() const override
get a list of applicable categories of the element.
double getPotential() const
get the value set for the potential in volts.
void setPotential(double potential)
set the value for the potential in volts.
void setVoltageVsOCP(bool vsOCP)
set whether to reference the specified voltage against the open-circuit voltage or the reference term...
void setApproxMaxCurrent(double approxMaxCurrent)
set maximum current expected, for manual current range selection.
double getMaxCapacity() const
get the value set for the maximum capacity / cumulative charge.
void setMaxCapacity(double maxCapacity)
set the value for the maximum capacity / cumulative charge in Coulomb.
double getMinAbsoluteCurrent() const
get the minimum value set for the absolute current in Amps. The experiment will end when the absolute...
double getMaxDuration() const
get the maximum duration set for the experiment. The experiment will end when the duration of the exp...
double getApproxMaxCurrent() const
get the value set for the expected maximum current.