Squidstat API User Manual
Loading...
Searching...
No Matches
AisConstantCurrentElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class ConstantCurrentAdvElement;
8
15class SQUIDSTATLIBRARY_EXPORT AisConstantCurrentElement final : public AisAbstractElement {
16public:
24 double current,
25 double samplingInterval,
26 double duration);
35
37
42 QString getName() const override;
43
48 QStringList getCategory() const override;
49
54 double getCurrent() const;
55
60 void setCurrent(double current);
61
66 double getSamplingInterval() const;
67
72 void setSamplingInterval(double samplingInterval);
73
83
96 void setMinSamplingVoltageDifference(double minVoltageDifference);
97
104 double getMaxVoltage() const;
105
114 void setMaxVoltage(double maxVoltage);
115
121 double getMinVoltage() const;
122
131 void setMinVoltage(double minVoltage);
132
138 double getMaxDuration() const;
139
146 void setMaxDuration(double maxDuration);
147
153 double getMaxCapacity() const;
154
163 void setMaxCapacity(double maxCapacity);
164
169 bool isAutoRange() const;
170
177
183 double getApproxMaxCurrent() const;
184
192 void setApproxMaxCurrent(double approxMaxCurrent);
193
198 bool isAutoVoltageRange() const;
199
206
207
213 double getApproxMaxVoltage() const;
214
222 void setApproxMaxVoltage(double approxMaxVoltage);
223
224private:
225 std::shared_ptr<ConstantCurrentAdvElement> m_dataDerived;
226};
an experiment that simulates a constant current flow with more advance options for stopping the exper...
Definition: AisConstantCurrentElement.h:15
double getApproxMaxVoltage() const
get the value set for the expected maximum voltage.
double getMaxVoltage() const
get the value set for the maximum voltage. The experiment will end when it reaches this value.
void setMaxCapacity(double maxCapacity)
set the value for the maximum capacity / cumulative charge in Coulomb.
AisConstantCurrentElement & operator=(const AisConstantCurrentElement &)
overload equal to operator for the AisConstantCurrentElement object.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
QString getName() const override
get the name of the element.
void setApproxMaxCurrent(double approxMaxCurrent)
set maximum current expected, for manual current range selection.
double getApproxMaxCurrent() const
get the value set for the expected maximum current.
void setAutoRange()
set to auto-select the current range.
double getMaxDuration() const
get the maximum duration set for the experiment. The experiment will end when the duration of the exp...
void setMaxDuration(double maxDuration)
set the maximum duration for the experiment.
void setAutoVoltageRange()
set to auto-select the voltage range.
double getMaxCapacity() const
get the value set for the maximum capacity / cumulative charge.
void setApproxMaxVoltage(double approxMaxVoltage)
set maximum voltage expected, for manual voltage range selection.
double getMinSamplingVoltageDifference() const
get the minimum sampling voltage difference for reporting the data.
void setMaxVoltage(double maxVoltage)
set a maximum voltage to stop the experiment.
AisConstantCurrentElement(const AisConstantCurrentElement &)
copy constructor for the AisConstantCurrentElement object.
void setMinVoltage(double minVoltage)
set a minimum voltage to stop the experiment.
double getSamplingInterval() const
get how frequently we are sampling the data.
QStringList getCategory() const override
get a list of applicable categories of the element.
void setMinSamplingVoltageDifference(double minVoltageDifference)
set a minimum sampling voltage difference for reporting the voltage.
double getCurrent() const
get the value set for the current.
double getMinVoltage() const
get the value set minimum for the voltage in volts.
bool isAutoRange() const
tells whether the current range is set to auto-select or not.
void setCurrent(double current)
set the value for the current.
bool isAutoVoltageRange() const
tells whether the voltage range is set to auto-select or not.
AisConstantCurrentElement(double current, double samplingInterval, double duration)
the constant current element constructor.