Squidstat API User Manual
Loading...
Searching...
No Matches
AisDCCurrentSweepElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class DCCurrentSweepElement;
8
17class SQUIDSTATLIBRARY_EXPORT AisDCCurrentSweepElement : public AisAbstractElement {
18public:
27 double startCurrent,
28 double endCurrent,
29 double scanRate,
30 double samplingInterval
31
32 );
41
43
48 QString getName() const override;
49
54 QStringList getCategory() const override;
55
60 double getQuietTime() const;
61
66 void setQuietTime(double quietTime);
67
73
78 void setQuietTimeSamplingInterval(double quietTimeSamplingInterval);
79
84 double getStartingCurrent() const;
85
90 void setStartingCurrent(double startingCurrent);
91
96 double getEndingCurrent() const;
97
102 void setEndingCurrent(double endingCurrent);
103
109 double getScanRate() const;
110
117 void setScanRate(double scanRate);
118
123 double getSamplingInterval() const;
124
129 void setSamplingInterval(double samplingInterval);
130
137 double getMaxVoltage() const;
138
147 void setMaxVoltage(double maxVoltage);
148
154 double getMinVoltage() const;
155
164 void setMinVoltage(double minVoltage);
165
172 double getAlphaFactor() const;
173
181 void setAlphaFactor(double alphaFactor);
182
183private:
184 std::shared_ptr<DCCurrentSweepElement> m_dataDerived;
185};
this experiment performs a DC current sweep from the starting current to the ending current which pro...
Definition: AisDCCurrentSweepElement.h:17
void setScanRate(double scanRate)
set the value for the current scan rate.
double getScanRate() const
get the value set for the scan rate.
void setEndingCurrent(double endingCurrent)
set the value for the ending current.
double getStartingCurrent() const
get the value set for the starting current.
void setStartingCurrent(double startingCurrent)
set the value for the starting current.
void setAlphaFactor(double alphaFactor)
alpha factor controls the percentage of data sampled during a given interval. Data will be averaged o...
AisDCCurrentSweepElement(const AisDCCurrentSweepElement &)
copy constructor for the AisDCCurrentSweepElement object.
double getEndingCurrent() const
get the value set for the ending current.
double getQuietTimeSamplingInterval() const
gets the quiet time sampling interval.
double getMaxVoltage() const
get the value set for the maximum voltage. The experiment will end when it reaches this value.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
double getMinVoltage() const
get the value set minimum for the voltage in volts.
double getAlphaFactor() const
Get the value set for the alpha factor.
double getSamplingInterval() const
get how frequently we are sampling the data.
AisDCCurrentSweepElement & operator=(const AisDCCurrentSweepElement &)
overload equal to operator for the AisDCCurrentSweepElement object.
void setQuietTime(double quietTime)
Sets the quiet time duration.
void setMaxVoltage(double maxVoltage)
set a maximum voltage to stop the experiment.
QStringList getCategory() const override
get a list of applicable categories of the element.
void setMinVoltage(double minVoltage)
set a minimum voltage to stop the experiment.
double getQuietTime() const
Gets the quiet time duration.
void setQuietTimeSamplingInterval(double quietTimeSamplingInterval)
Sets the quiet time sampling interval.
AisDCCurrentSweepElement(double startCurrent, double endCurrent, double scanRate, double samplingInterval)
the DC current sweep element.
QString getName() const override
get the name of the element.