Squidstat API User Manual
Loading...
Searching...
No Matches
AisSteppedVoltageElement.h
1#pragma once
2
3#pragma once
4
5#include "AisAbstractElement.h"
6#include "AisSquidstatGlobal.h"
7#include <QString>
8
9class SteppedVoltage;
10
21class SQUIDSTATLIBRARY_EXPORT AisSteppedVoltageElement final : public AisAbstractElement {
22public:
34 explicit AisSteppedVoltageElement(double startVoltage,
35 double endVoltage,
36 double voltageStep,
37 double voltageStepDuration,
38 double samplingInterval);
39
45
52
57
62 QString getName() const override;
63
68 QStringList getCategory() const override;
69
74 double getStartVoltage() const;
75
80 double getEndVoltage() const;
81
86 double getStepSize() const;
87
92 double getStepDuration() const;
93
98 double getSamplingInterval() const;
99
104 double getApproxMaxCurrent() const;
105
111
116 bool isEndVoltageVsOCP() const;
117
122 bool isAutoRange() const;
123
128 void setStartVoltage(double vStart);
129
134 void setEndVoltage(double vEnd);
135
141 void setStepSize(double vStep);
142
147 void setStepDuration(double duration);
148
153 void setSamplingInterval(double samplingInterval);
154
159 void setApproxMaxCurrent(double approxMaxCurrent);
160
165 void setStartVoltageVsOCP(bool startVsOCP);
166
171 void setEndVoltageVsOCP(bool endVsOCP);
172
177
178private:
179 std::shared_ptr<SteppedVoltage> m_dataDerived;
180};
181
A class representing an experiment to apply the stepped volatge.
Definition: AisSteppedVoltageElement.h:21
void setStartVoltage(double vStart)
Set the starting voltage for the experiment.
bool isAutoRange() const
Check if current autoranging is enabled.
~AisSteppedVoltageElement() override
Destructor for the AisSteppedVoltageElement object.
void setStepSize(double vStep)
Set the voltage step for each iteration.
void setCurrentAutorange()
Enable current autoranging for the experiment.
AisSteppedVoltageElement(const AisSteppedVoltageElement &other)
Copy constructor for the AisSteppedVoltageElement object.
void setApproxMaxCurrent(double approxMaxCurrent)
Set the approximate maximum current.
double getStepDuration() const
Get the time step for each iteration.
double getStepSize() const
Get the voltage step for each iteration.
double getEndVoltage() const
Get the ending voltage for the experiment.
double getStartVoltage() const
Get the starting voltage for the experiment.
void setEndVoltage(double vEnd)
Set the ending voltage for the experiment.
AisSteppedVoltageElement & operator=(const AisSteppedVoltageElement &other)
Overloaded assignment operator for the AisSteppedVoltageElement object.
void setEndVoltageVsOCP(bool endVsOCP)
Set whether the experiment ends with the open circuit potential.
QString getName() const override
Get the name of the element.
void setSamplingInterval(double samplingInterval)
Set the data sampling interval.
double getApproxMaxCurrent() const
Get the approximate maximum current.
bool isEndVoltageVsOCP() const
Check if the experiment ends with the open circuit potential.
bool isStartVoltageVsOCP() const
Check if the experiment starts with the open circuit potential.
void setStartVoltageVsOCP(bool startVsOCP)
Set whether the experiment starts with the open circuit potential.
QStringList getCategory() const override
Get a list of applicable categories of the element.
AisSteppedVoltageElement(double startVoltage, double endVoltage, double voltageStep, double voltageStepDuration, double samplingInterval)
Constructor for the AisSteppedVoltageElement element.
void setStepDuration(double duration)
Set the time step for each iteration.
double getSamplingInterval() const
Get the data sampling interval.