Squidstat API User Manual
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
15class SQUIDSTATLIBRARY_EXPORT AisConstantPotElement final : public AisAbstractElement {
16public:
24 double voltage,
25 double samplingInterval,
26 double duration);
31
36
37 ~AisConstantPotElement() override;
38
43 QString getName() const override;
44
49 QStringList getCategory() const override;
50
55 double getPotential() const;
56
61 void setPotential(double potential);
62
68 bool isVoltageVsOCP() const;
69
76 void setVoltageVsOCP(bool vsOCP);
77
82 double getSamplingInterval() const;
83
88 void setSamplingInterval(double samplingInterval);
89
95 double getMaxDuration() const;
96
105 void setMaxDuration(double maxDuration);
106
113 double getMaxAbsoluteCurrent() const;
114
123 void setMaxAbsoluteCurrent(double maxCurrent);
124
132 [[deprecated("getMaxCurrent has been renamed getMaxAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
133 double getMaxCurrent() const;
134
144 [[deprecated("setMaxCurrent has been renamed setMaxAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
145 void setMaxCurrent(double maxCurrent);
146
153 double getMinAbsoluteCurrent() const;
154
163 void setMinAbsoluteCurrent(double minCurrent);
164
172 [[deprecated("getMinCurrent has been renamed getMinAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
173 double getMinCurrent() const;
174
184 [[deprecated("setMinCurrent has been renamed setMinAbsoluteCurrent for description accuracy. In future versions this function may be removed or modified.")]]
185 void setMinCurrent(double minCurrent);
186
192 double getMaxCapacity() const;
193
202 void setMaxCapacity(double maxCapacity);
203
209 double getMindIdt() const;
210
219 void setMindIdt(double mindIdt);
220
225 bool isAutoRange() const;
226
233
239 double getApproxMaxCurrent() const;
240
248 void setApproxMaxCurrent(double approxMaxCurrent);
249
254 int getVoltageRange() const;
255
263 void setVoltageRange(int idx);
264
265private:
266 std::shared_ptr<ConstantPotAdvElement> m_dataDerived;
267};
an experiment that simulates a constant applied voltage.
Definition: AisConstantPotElement.h:15
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.