an experiment that simulates a constant current flow with more advance options for stopping the experiment.
More...

#include <AisConstantCurrentElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisConstantCurrentElement (double current, double samplingInterval, double duration)
	the constant current element constructor. More...

	AisConstantCurrentElement (const AisConstantCurrentElement &)
	copy constructor for the AisConstantCurrentElement object.

AisConstantCurrentElement &	operator= (const AisConstantCurrentElement &)
	overload equal to operator for the AisConstantCurrentElement object.

QString	getName () const override
	get the name of the element. More...

QStringList	getCategory () const override
	get a list of applicable categories of the element. More...

double	getCurrent () const
	get the value set for the current. More...

void	setCurrent (double current)
	set the value for the current. More...

double	getSamplingInterval () const
	get how frequently we are sampling the data. More...

void	setSamplingInterval (double samplingInterval)
	set how frequently we are sampling the data. More...

double	getMinSamplingVoltageDifference () const
	get the minimum sampling voltage difference for reporting the data. More...

void	setMinSamplingVoltageDifference (double minVoltageDifference)
	set a minimum sampling voltage difference for reporting the voltage. More...

double	getMaxVoltage () const
	get the value set for the maximum voltage. The experiment will end when it reaches this value. More...

void	setMaxVoltage (double maxVoltage)
	set a maximum voltage to stop the experiment. More...

double	getMinVoltage () const
	get the value set minimum for the voltage in volts. More...

void	setMinVoltage (double minVoltage)
	set a minimum voltage to stop the experiment. More...

double	getMaxDuration () const
	get the maximum duration set for the experiment. The experiment will end when the duration of the experiment reaches this value. More...

void	setMaxDuration (double maxDuration)
	set the maximum duration for the experiment. More...

double	getMaxCapacity () const
	get the value set for the maximum capacity / cumulative charge. More...

void	setMaxCapacity (double maxCapacity)
	set the value for the maximum capacity / cumulative charge in Coulomb. More...

bool	isAutoRange () const
	tells whether the current range is set to auto-select or not. More...

void	setAutoRange ()
	set to auto-select the current range. More...

double	getApproxMaxCurrent () const
	get the value set for the expected maximum current. More...

void	setApproxMaxCurrent (double approxMaxCurrent)
	set maximum current expected, for manual current range selection. More...

bool	isAutoVoltageRange () const
	tells whether the voltage range is set to auto-select or not. More...

void	setAutoVoltageRange ()
	set to auto-select the voltage range. More...

double	getApproxMaxVoltage () const
	get the value set for the expected maximum voltage. More...

void	setApproxMaxVoltage (double approxMaxVoltage)
	set maximum voltage expected, for manual voltage range selection. More...

Detailed Description

an experiment that simulates a constant current flow with more advance options for stopping the experiment.

Constructor & Destructor Documentation

◆ AisConstantCurrentElement()

AisConstantCurrentElement::AisConstantCurrentElement	(	double	current,
		double	samplingInterval,
		double	duration
	)

explicit

the constant current element constructor.

Parameters

current	the value for the current in Amps.
samplingInterval	the data sampling interval value in seconds.
duration	the maximum duration for the experiment in seconds.

Member Function Documentation

◆ getApproxMaxCurrent()

double AisConstantCurrentElement::getApproxMaxCurrent ( ) const

get the value set for the expected maximum current.

Returns: the value set for the expected maximum current in Amps.

Note: if nothing was manually set, the device will auto-select the current range and the return value will be positive infinity.

◆ getApproxMaxVoltage()

double AisConstantCurrentElement::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 AisConstantCurrentElement::getCategory ( ) const

override

get a list of applicable categories of the element.

Returns: A list of applicable categories: ("Galvanostatic Control", "Basic Experiments").

◆ getCurrent()

double AisConstantCurrentElement::getCurrent ( ) const

get the value set for the current.

Returns: the value for the current in Amps.

◆ getMaxCapacity()

double AisConstantCurrentElement::getMaxCapacity ( ) const

get the value set for the maximum capacity / cumulative charge.

Returns: the value set for the maximum capacity in Coulomb.

Note: this is an optional parameter. If no value has been set, the default value is positive infinity.

◆ getMaxDuration()

double AisConstantCurrentElement::getMaxDuration ( ) const

get the maximum duration set for the experiment. The experiment will end when the duration of the experiment reaches this value.

Returns: the maximum duration for the experiment in seconds.

◆ getMaxVoltage()

double AisConstantCurrentElement::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

◆ getMinSamplingVoltageDifference()

double AisConstantCurrentElement::getMinSamplingVoltageDifference ( ) const

get the minimum sampling voltage difference for reporting the data.

get the value set for the minimum sampling voltage difference.

Returns: the value set for the minimum sampling voltage difference.

See also: setMinSamplingVoltageDifference

Note: this is an optional parameter. If no value has been set, the default value is negative infinity.

◆ getMinVoltage()

double AisConstantCurrentElement::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 AisConstantCurrentElement::getName ( ) const

override

get the name of the element.

Returns: The name of the element: "Constant Current, Advanced".

◆ getSamplingInterval()

double AisConstantCurrentElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ isAutoRange()

bool AisConstantCurrentElement::isAutoRange ( ) const

tells whether the current range is set to auto-select or not.

Returns: true if the current range is set to auto-select and false if a range has been selected.

◆ isAutoVoltageRange()

bool AisConstantCurrentElement::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.

◆ setApproxMaxCurrent()

void AisConstantCurrentElement::setApproxMaxCurrent ( double approxMaxCurrent )

set maximum current expected, for manual current range selection.

This is an optional parameter. If nothing is set, the device will auto-select the current range.

Parameters

approxMaxCurrent the value for the maximum current expected in Amps.

◆ setApproxMaxVoltage()

void AisConstantCurrentElement::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 current expected in V.

◆ setAutoRange()

void AisConstantCurrentElement::setAutoRange ( )

set to auto-select the current 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.

◆ setAutoVoltageRange()

void AisConstantCurrentElement::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.

◆ setCurrent()

void AisConstantCurrentElement::setCurrent ( double current )

set the value for the current.

Parameters

current the value for the current in Amps.

◆ setMaxCapacity()

void AisConstantCurrentElement::setMaxCapacity ( double maxCapacity )

set the value for the maximum capacity / cumulative charge in Coulomb.

This is an optional condition. If nothing is set, then the experiment will not stop based on an upper-limit cumulative charge value. If a maximum capacity is set, the experiment will continue to run as long as the cumulative charge is below that value.

Parameters

maxCapacity the value to set for the cell maximum capacity.

◆ setMaxDuration()

void AisConstantCurrentElement::setMaxDuration ( double maxDuration )

set the maximum duration for the experiment.

The experiment will continue to run as long as the time passed is less than the value to set.

Parameters

maxDuration the maximum duration for the experiment in seconds.

◆ setMaxVoltage()

void AisConstantCurrentElement::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.

◆ setMinSamplingVoltageDifference()

void AisConstantCurrentElement::setMinSamplingVoltageDifference ( double minVoltageDifference )

set a minimum sampling voltage difference for reporting the voltage.

This is an optional condition. If nothing is set, then the experiment will report the data at time sampling interval. When this is set, then the voltage is reported when there is a voltage difference of at least the given minimum sampling voltage difference. So, when one voltage data point is reported (at the minimum possible time sampling interval), the next data point is not reported unless the difference between the two voltage data points exceeds this given minimum sampling voltage difference value.

Note: when this is set, this overrides the set value for the sampling interval.

Parameters

minVoltageDifference the minimum sampling voltage difference value in volts.

◆ setMinVoltage()

void AisConstantCurrentElement::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 AisConstantCurrentElement::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:

AisConstantCurrentElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisConstantCurrentElement()

Member Function Documentation

◆ getApproxMaxCurrent()

◆ getApproxMaxVoltage()

◆ getCategory()

◆ getCurrent()

◆ getMaxCapacity()

◆ getMaxDuration()

◆ getMaxVoltage()

◆ getMinSamplingVoltageDifference()

◆ getMinVoltage()

◆ getName()

◆ getSamplingInterval()

◆ isAutoRange()

◆ isAutoVoltageRange()

◆ setApproxMaxCurrent()

◆ setApproxMaxVoltage()

◆ setAutoRange()

◆ setAutoVoltageRange()

◆ setCurrent()

◆ setMaxCapacity()

◆ setMaxDuration()

◆ setMaxVoltage()

◆ setMinSamplingVoltageDifference()

◆ setMinVoltage()

◆ setSamplingInterval()