Squidstat API User Manual
Loading...
Searching...
No Matches
AisOpenCircuitElement.h
1#pragma once
2
3#include "AisAbstractElement.h"
4#include "AisSquidstatGlobal.h"
5#include <QString>
6
7class OpenCircuitElement;
8
15class SQUIDSTATLIBRARY_EXPORT AisOpenCircuitElement final : public AisAbstractElement {
16public:
23 double duration,
24 double samplingInterval);
33
34 ~AisOpenCircuitElement() override;
35
40 QString getName() const override;
41
46 QStringList getCategory() const override;
47
52 double getSamplingInterval() const;
53
58 void setSamplingInterval(double samplingInterval);
59
64 double getMaxDuration() const;
65
70 void setMaxDuration(double maxDuration);
71
78 double getMaxVoltage() const;
79
88 void setMaxVoltage(double maxVoltage);
89
95 double getMinVoltage() const;
96
105 void setMinVoltage(double minVoltage);
106
113 double getMindVdt() const;
114
123 void setMindVdt(double mindVdt);
124
129 bool isAutoVoltageRange() const;
130
137
143 double getApproxMaxVoltage() const;
144
152 void setApproxMaxVoltage(double approxMaxVoltage);
153
154private:
155 std::shared_ptr<OpenCircuitElement> m_dataDerived;
156};
This experiment observes the open circuit potential of the working electrode for a specific period of...
Definition: AisOpenCircuitElement.h:15
void setMaxDuration(double maxDuration)
set the value set for the duration of the experiment.
void setMaxVoltage(double maxVoltage)
set a maximum voltage to stop the experiment.
AisOpenCircuitElement & operator=(const AisOpenCircuitElement &)
overload equal to operator for the AisOpenCircuitElement object.
QStringList getCategory() const override
get a list of applicable categories of the element.
double getMaxVoltage() const
get the value set for the maximum voltage. The experiment will end when it reaches this value.
AisOpenCircuitElement(double duration, double samplingInterval)
the open-circuit element constructor.
double getSamplingInterval() const
get how frequently we are sampling the data.
double getApproxMaxVoltage() const
get the value set for the expected maximum voltage.
bool isAutoVoltageRange() const
tells whether the voltage range is set to auto-select or not.
void setMinVoltage(double minVoltage)
set a minimum voltage to stop the experiment.
void setSamplingInterval(double samplingInterval)
set how frequently we are sampling the data.
void setMindVdt(double mindVdt)
set the minimum value for the voltage rate of change with respect to time (minimum dV/dt).
void setAutoVoltageRange()
set to auto-select the voltage range.
AisOpenCircuitElement(const AisOpenCircuitElement &)
copy constructor for the AisOpenCircuitElement object.
double getMinVoltage() const
get the value set minimum for the voltage in volts.
void setApproxMaxVoltage(double approxMaxVoltage)
set maximum voltage expected, for manual voltage range selection.
double getMindVdt() const
get the value set for the minimum voltage rate of change with respect to time (minimum dV/dt).
QString getName() const override
get the name of the element.
double getMaxDuration() const
get the value set for the duration of the experiment.