Squidstat API User Manual
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
15class SQUIDSTATLIBRARY_EXPORT AisConstantPowerElement final : public AisAbstractElement {
16public:
24 double power,
25 double duration,
26 double samplingInterval);
27
38 [[deprecated("Future versions will no longer support the AisConstantPowerElement with the 'isCharge' parameter. Power can be set to a positive or negative value instead.")]]
40 bool isCharge,
41 double power,
42 double duration,
43 double samplingInterval);
44
49
54
55 ~AisConstantPowerElement() override;
56
61 QString getName() const override;
62
67 QStringList getCategory() const override;
68
73 bool isCharge() const;
74
82 [[deprecated("Future versions will no longer support setCharge. Power can be set to a positive or negative value instead.")]]
83 void setCharge(bool isCharge);
84
89 double getPower() const;
90
95 void setPower(double power);
96
101 double getSamplingInterval() const;
102
107 void setSamplingInterval(double samplingInterval);
108
115 double getMaxVoltage() const;
116
125 void setMaxVoltage(double maxVoltage);
126
127
134
141 void setMaximumVoltageVsOCP(bool vsOCP);
142
143
150 double getMinVoltage() const;
151
158 void setMinVoltage(double minVoltage);
159
166
173 void setMinimumVoltageVsOCP(bool vsOCP);
174
180 double getMaxCurrent() const;
181
190 void setMaxCurrent(double maxCurrent);
191
197 double getMinCurrent() const;
198
207 void setMinCurrent(double maxCurrent);
208
214 double getMaxDuration() const;
215
222 void setMaxDuration(double maxDuration);
223
229 double getMaxCapacity() const;
230
239 void setMaxCapacity(double maxCapacity);
240
241private:
242 std::shared_ptr<ConstantPowerElement> m_dataDerived;
243};
This experiment simulates a constant power, charge or discharge".
Definition: AisConstantPowerElement.h:15
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.