Loading...
Searching...
No Matches
AisConstantPowerElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class ConstantPowerElement;
8
18class SQUIDSTATLIBRARY_EXPORT AisConstantPowerElement final : public AisAbstractElement {
19public:
27 double power,
28 double duration,
29 double samplingInterval);
30
41 [[deprecated("Future versions will no longer support the AisConstantPowerElement with the 'isCharge' parameter. Power can be set to a positive or negative value instead.")]]
43 bool isCharge,
44 double power,
45 double duration,
46 double samplingInterval);
47
52
57
58 ~AisConstantPowerElement() override;
59
64 QString getName() const override;
65
70 QStringList getCategory() const override;
71
76 bool isCharge() const;
77
85 [[deprecated("Future versions will no longer support setCharge. Power can be set to a positive or negative value instead.")]]
86 void setCharge(bool isCharge);
87
92 double getPower() const;
93
98 void setPower(double power);
99
104 double getSamplingInterval() const;
105
110 void setSamplingInterval(double samplingInterval);
111
118 double getMaxVoltage() const;
119
128 void setMaxVoltage(double maxVoltage);
129
130
137
144 void setMaximumVoltageVsOCP(bool vsOCP);
145
146
153 double getMinVoltage() const;
154
161 void setMinVoltage(double minVoltage);
162
169
176 void setMinimumVoltageVsOCP(bool vsOCP);
177
183 double getMaxCurrent() const;
184
193 void setMaxCurrent(double maxCurrent);
194
200 double getMinCurrent() const;
201
210 void setMinCurrent(double maxCurrent);
211
217 double getMaxDuration() const;
218
225 void setMaxDuration(double maxDuration);
226
232 double getMaxCapacity() const;
233
242 void setMaxCapacity(double maxCapacity);
243
244private:
245 std::shared_ptr<ConstantPowerElement> m_dataDerived;
246};
This experiment simulates a constant power, charge or discharge".
Definition AisConstantPowerElement.h:18
void setMaxCurrent(double maxCurrent)
set a maximum current to stop the experiment.
bool isMinimumVoltageVsOCP() const
tells whether the specified minimum voltage is set against the open-circuit voltage or the reference ...
bool isMaximumVoltageVsOCP() const
tells whether the specified maximum voltage is set against the open-circuit voltage or the reference ...
void setMaximumVoltageVsOCP(bool vsOCP)
set whether to reference the specified maximum voltage against the open-circuit voltage or the refere...
void setMinVoltage(double minVoltage)
set a minimum value for the voltage. The experiment will end when it reaches down this value.
double getPower() const
get the value set for the power.
QStringList getCategory() const override
get a list of applicable categories of the element.
void setMaxVoltage(double maxVoltage)
set a maximum voltage to stop the experiment.
void setMinimumVoltageVsOCP(bool vsOCP)
set whether to reference the specified minimum voltage against the open-circuit voltage or the refere...
void setCharge(bool isCharge)
set whether the experiment is to simulate charge or discharge.
double getMaxCurrent() const
get the value set maximum for the current in amps.
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.
double getMaxVoltage() const
get the value set for the maximum voltage. The experiment will end when it reaches this value.
double getMaxCapacity() const
get the value set for the maximum capacity / cumulative charge.
double getMinVoltage() const
get the minimum value set for the voltage in volts. The experiment will end when it reaches down this...
AisConstantPowerElement(double power, double duration, double samplingInterval)
the constant power element constructor
AisConstantPowerElement(const AisConstantPowerElement &)
copy constructor for the AisConstantPowerElement object.
QString getName() const override
get the name of the element.
AisConstantPowerElement & operator=(const AisConstantPowerElement &)
overload equal to operator for the AisConstantPowerElement object.
AisConstantPowerElement(bool isCharge, double power, double duration, double samplingInterval)
the constant power element constructor that supports the isCharge parameter
void setPower(double power)
set the value for the power.
double getSamplingInterval() const
get how frequently we are sampling the data.
void setMaxCapacity(double maxCapacity)
set the value for the maximum capacity / cumulative charge in Coulomb.
double getMaxDuration() const
get the maximum duration set for the experiment. The experiment will end when the duration of the exp...
bool isCharge() const
tells whether the experiment is set to simulate charge or discharge.
void setMaxDuration(double maxDuration)
set the maximum duration for the experiment.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.