This experiment observes the open circuit potential of the working electrode for a specific period of time.
More...
#include <AisOpenCircuitElement.h>
Inherits AisAbstractElement.
This experiment observes the open circuit potential of the working electrode for a specific period of time.
◆ AisOpenCircuitElement()
| AisOpenCircuitElement::AisOpenCircuitElement |
( |
double |
duration, |
|
|
double |
samplingInterval |
|
) |
| |
|
explicit |
the open-circuit element constructor.
- Parameters
-
| duration | the maximum duration for the experiment in seconds. |
| samplingInterval | the data sampling interval value in seconds. |
◆ getApproxMaxVoltage()
| double AisOpenCircuitElement::getApproxMaxVoltage |
( |
| ) |
const |
get the value set for the expected maximum voltage.
- Returns
- the value set for the expected maximum Voltage in volt.
- Note
- if nothing was manually set, the device will auto-select the voltage range and the return value will be positive infinity.
◆ getCategory()
| QStringList AisOpenCircuitElement::getCategory |
( |
| ) |
const |
|
override |
get a list of applicable categories of the element.
- Returns
- A list of applicable categories: ("Basic Experiments").
◆ getMaxDuration()
| double AisOpenCircuitElement::getMaxDuration |
( |
| ) |
const |
get the value set for the duration of the experiment.
- Returns
- the value set for the duration of the experiment in seconds.
◆ getMaxVoltage()
| double AisOpenCircuitElement::getMaxVoltage |
( |
| ) |
const |
get the value set for the maximum voltage. The experiment will end when it reaches this value.
- Returns
- the value set for the maximum voltage.
- Note
- this is an optional parameter. If no value has been set, the default value is positive infinity.
◆ getMindVdt()
| double AisOpenCircuitElement::getMindVdt |
( |
| ) |
const |
get the value set for the minimum voltage rate of change with respect to time (minimum dV/dt).
- Returns
- the value set for the minimum voltage rate of change with respect to time (minimum dV/dt).
- Note
- this is an optional parameter. If no value has been set, the default value is zero
◆ getMinVoltage()
| double AisOpenCircuitElement::getMinVoltage |
( |
| ) |
const |
get the value set minimum for the voltage in volts.
- Returns
- the value set for the minimum voltage in volts.
- Note
- this is an optional parameter. If no value has been set, the default value is negative infinity.
◆ getName()
| QString AisOpenCircuitElement::getName |
( |
| ) |
const |
|
override |
get the name of the element.
- Returns
- The name of the element: "Open Circuit Potential".
◆ getSamplingInterval()
| double AisOpenCircuitElement::getSamplingInterval |
( |
| ) |
const |
get how frequently we are sampling the data.
- Returns
- the data sampling interval value in seconds.
◆ isAutoVoltageRange()
| bool AisOpenCircuitElement::isAutoVoltageRange |
( |
| ) |
const |
tells whether the voltage range is set to auto-select or not.
- Returns
- true if the voltage range is set to auto-select and false if a range has been selected.
◆ setApproxMaxVoltage()
| void AisOpenCircuitElement::setApproxMaxVoltage |
( |
double |
approxMaxVoltage | ) |
|
set maximum voltage expected, for manual voltage range selection.
This is an optional parameter. If nothing is set, the device will auto-select the voltage range.
- Parameters
-
| approxMaxVoltage | the value for the maximum voltage expected in V. |
◆ setAutoVoltageRange()
| void AisOpenCircuitElement::setAutoVoltageRange |
( |
| ) |
|
set to auto-select the voltage range.
This option is set by default. There is no need to call this function to auto-select if the range was not manually set.
◆ setMaxDuration()
| void AisOpenCircuitElement::setMaxDuration |
( |
double |
maxDuration | ) |
|
set the value set for the duration of the experiment.
- Parameters
-
| maxDuration | the value to set for the duration of the experiment in seconds. |
◆ setMaxVoltage()
| void AisOpenCircuitElement::setMaxVoltage |
( |
double |
maxVoltage | ) |
|
set a maximum voltage to stop the experiment.
This is an optional condition. If nothing is set, then the experiment will not stop based on an upper-limit voltage value. If a maximum voltage is set, the experiment will continue to run as long as the measured voltage is below that value.
- Parameters
-
| maxVoltage | the maximum voltage value in volts at which the experiment will stop. |
◆ setMindVdt()
| void AisOpenCircuitElement::setMindVdt |
( |
double |
mindVdt | ) |
|
set the minimum value for the voltage rate of change with respect to time (minimum dV/dt).
This is an optional condition. If nothing is set, then the experiment will not stop based on an lower-limit rate of change value. If a minimum value is set, the experiment will continue to run as long as the rage of change is above that value.
- Parameters
-
| mindVdt | the minimum value for the voltage rate of change with respect to time (minimum dV/dt). |
◆ setMinVoltage()
| void AisOpenCircuitElement::setMinVoltage |
( |
double |
minVoltage | ) |
|
set a minimum voltage to stop the experiment.
This is an optional condition. If nothing is set, then the experiment will not stop based on an lower-limit voltage value. If a maximum voltage is set, the experiment will continue to run as long as the measured voltage is above that value.
- Parameters
-
| minVoltage | the minimum voltage value in volts at which the experiment will stop. |
◆ setSamplingInterval()
| void AisOpenCircuitElement::setSamplingInterval |
( |
double |
samplingInterval | ) |
|
set how frequently we are sampling the data.
- Parameters
-
| samplingInterval | the data sampling interval value in seconds. |
The documentation for this class was generated from the following file:
1.9.5