Squidstat API User Manual
Loading...
Searching...
No Matches
AisConstantResistanceElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class ConstantResistanceElement;
8
15class SQUIDSTATLIBRARY_EXPORT AisConstantResistanceElement final : public AisAbstractElement {
16public:
24 double resistance,
25 double duration,
26 double samplingInterval);
35
37
42 QString getName() const override;
43
48 QStringList getCategory() const override;
49
54 double getResistance() const;
55
60 void setResistance(double resistance);
61
66 double getSamplingInterval() const;
67
72 void setSamplingInterval(double samplingInterval);
73
79 double getMinVoltage() const;
80
89 void setMinVoltage(double minVoltage);
90
97
104 void setMinimumVoltageVsOCP(bool vsOCP);
105
111 double getMaxVoltage() const;
112
121 void setMaxVoltage(double maxVoltage);
122
129
136 void setMaximumVoltageVsOCP(bool vsOCP);
137
143 double getMaxCurrent() const;
144
153 void setMaxCurrent(double maxCurrent);
154
160 double getMinCurrent() const;
161
170 void setMinCurrent(double maxCurrent);
171
177 double getMaxDuration() const;
178
185 void setMaxDuration(double maxDuration);
186
192 double getMaxCapacity() const;
193
202 void setMaxCapacity(double maxCapacity);
203
204private:
205 std::shared_ptr<ConstantResistanceElement> m_dataDerived;
206};
This element/experiment simulates a constant resistance load.
Definition: AisConstantResistanceElement.h:15
double getMaxDuration() const
get the maximum duration set for the experiment. The experiment will end when the duration of the exp...
void setMinCurrent(double maxCurrent)
set a minimum current to stop the experiment.
double getMinCurrent() const
get the value set minimum for the current in amps.
bool isMinimumVoltageVsOCP() const
tells whether the specified minimum voltage is set against the open-circuit voltage or the reference ...
double getMaxVoltage() const
get the value set maximum for the voltage in volts.
bool isMaximumVoltageVsOCP() const
tells whether the specified maximum voltage is set against the open-circuit voltage or the reference ...
AisConstantResistanceElement(double resistance, double duration, double samplingInterval)
the constant resistance element constructor.
void setMaxCapacity(double maxCapacity)
set the value for the maximum capacity / cumulative charge in Coulomb.
void setMaximumVoltageVsOCP(bool vsOCP)
set whether to reference the specified maximum voltage against the open-circuit voltage or the refere...
double getMaxCapacity() const
get the value set for the maximum capacity / cumulative charge.
QStringList getCategory() const override
get a list of applicable categories of the element.
AisConstantResistanceElement(const AisConstantResistanceElement &)
copy constructor for the AisConstantResistanceElement object.
double getMaxCurrent() const
get the value set maximum for the current in amps.
double getSamplingInterval() const
get how frequently we are sampling the data.
void setMinimumVoltageVsOCP(bool vsOCP)
set whether to reference the specified minimum voltage against the open-circuit voltage or the refere...
double getMinVoltage() const
get the value set minimum for the voltage in volts.
void setMaxCurrent(double maxCurrent)
set a maximum current to stop the experiment.
void setMaxDuration(double maxDuration)
set the maximum duration for the experiment.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
void setMaxVoltage(double maxVoltage)
set a maximum voltage to stop the experiment.
double getResistance() const
get the value set for the resistance as a load.
QString getName() const override
get the name of the element.
AisConstantResistanceElement & operator=(const AisConstantResistanceElement &)
overload equal to operator for the AisConstantResistanceElement object.
void setResistance(double resistance)
set the value for the resistance as a load
void setMinVoltage(double minVoltage)
set a minimum voltage to stop the experiment.