Squidstat API User Manual
Loading...
Searching...
No Matches
AisSteppedCurrentElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class SteppedCurrent;
8
15class SQUIDSTATLIBRARY_EXPORT AisSteppedCurrentElement final : public AisAbstractElement {
16public:
29 double startCurrent,
30 double endCurrent,
31 double stepSize,
32 double stepDuration,
33 double samplingInterval);
42
44
49 QString getName() const override;
50
55 QStringList getCategory() const override;
56
61 double getSamplingInterval() const;
62
67 void setSamplingInterval(double samplingInterval);
68
74 double getEndCurrent() const;
75
81 double getStepSize() const;
82
88 double getStartCurrent() const;
89
95 double getStepDuration() const;
96
102 void setEndCurrent(double iEnd);
103
110 void setStepSize(double iStep);
111
117 void setStartCurrent(double iStart);
118
124 void setStepDuration(double tStep);
125
131 double getApproxMaxVoltage() const;
132
140 void setApproxMaxVoltage(double approxMaxVoltage);
141
147 double getApproxMinVoltage() const;
148
156 void setApproxMinVoltage(double approxMinVoltage);
157
158private:
159 std::shared_ptr<SteppedCurrent> m_dataDerived;
160};
A class representing an experiment to apply the stepped current.
Definition: AisSteppedCurrentElement.h:15
void setEndCurrent(double iEnd)
Sets the ending current value for the stepped experiment.
QString getName() const override
get the name of the element.
AisSteppedCurrentElement & operator=(const AisSteppedCurrentElement &)
overload equal to operator for the AisSteppedCurrentElement object.
double getApproxMinVoltage() const
get the value set for the expected minimum voltage.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
double getStepSize() const
Gets the size of each current step in the stepped experiment.
void setApproxMinVoltage(double approxMinVoltage)
set minimum voltage expected, for manual voltage range selection.
double getEndCurrent() const
Gets the ending current value for the stepped experiment.
double getApproxMaxVoltage() const
get the value set for the expected maximum voltage.
AisSteppedCurrentElement(const AisSteppedCurrentElement &)
copy constructor for the AisSteppedCurrentElement object.
double getStartCurrent() const
Gets the starting current value for the stepped experiment.
void setStartCurrent(double iStart)
Sets the starting current value for the stepped experiment.
QStringList getCategory() const override
get a list of applicable categories of the element.
double getStepDuration() const
Gets the duration of each current step in the stepped experiment.
void setStepSize(double iStep)
Sets the size of each current step in the stepped experiment.
void setStepDuration(double tStep)
Sets the duration of each current step in the stepped experiment.
double getSamplingInterval() const
get how frequently we are sampling the data.
void setApproxMaxVoltage(double approxMaxVoltage)
set maximum voltage expected, for manual voltage range selection.
AisSteppedCurrentElement(double startCurrent, double endCurrent, double stepSize, double stepDuration, double samplingInterval)
Constructs a Stepped Current element.