an experiment that simulates a constant applied voltage.
More...

#include <AisConstantPotElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisConstantPotElement (double voltage, double samplingInterval, double duration)
	the constant potential element constructor. More...

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

AisConstantPotElement &	operator= (const AisConstantPotElement &)
	overload equal to operator for the AisConstantPotElement 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	getPotential () const
	get the value set for the potential in volts. More...

void	setPotential (double potential)
	set the value for the potential in volts. More...

bool	isVoltageVsOCP () const
	tells whether the specified voltage is set against the open-circuit voltage or the reference terminal. More...

void	setVoltageVsOCP (bool vsOCP)
	set whether to reference the specified voltage against the open-circuit voltage or the reference terminal. 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	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	getMaxAbsoluteCurrent () const
	get the maximum value set for the absolute current in Amps. The experiment will end when the absolute current reaches this value. More...

void	setMaxAbsoluteCurrent (double maxCurrent)
	set the maximum value for the absolute current in Amps. More...

double	getMaxCurrent () const
	get the maximum value set for the absolute current in Amps. The experiment will end when the absolute current reaches this value. More...

void	setMaxCurrent (double maxCurrent)
	set the maximum value for the absolute current in Amps. More...

double	getMinAbsoluteCurrent () const
	get the minimum value set for the absolute current in Amps. The experiment will end when the absolute current falls down to this value. More...

void	setMinAbsoluteCurrent (double minCurrent)
	set the minimum value for the absolute current in Amps. More...

double	getMinCurrent () const
	get the minimum value set for the absolute current in Amps. The experiment will end when the absolute current falls down to this value. More...

void	setMinCurrent (double minCurrent)
	set the minimum value for the absolute current in Amps. 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...

double	getMindIdt () const
	get the value set for the minimum current rate of change with respect to time (minimum di/dt). More...

void	setMindIdt (double mindIdt)
	set the minimum value for the current rate of change with respect to time (minimum di/dt). 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...

int	getVoltageRange () const
	get the value set for the voltage range. More...

void	setVoltageRange (int idx)
	manually set the voltage control range. More...

Detailed Description

an experiment that simulates a constant applied voltage.

Constructor & Destructor Documentation

◆ AisConstantPotElement()

AisConstantPotElement::AisConstantPotElement	(	double	voltage,
		double	samplingInterval,
		double	duration
	)

explicit

the constant potential element constructor.

Parameters

voltage	the value set for the voltage/potential in volts.
samplingInterval	the data sampling interval value in seconds.
duration	the maximum duration for the experiment in seconds.

Member Function Documentation

◆ getApproxMaxCurrent()

double AisConstantPotElement::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.

◆ getCategory()

QStringList AisConstantPotElement::getCategory ( ) const

override

get a list of applicable categories of the element.

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

◆ getMaxAbsoluteCurrent()

double AisConstantPotElement::getMaxAbsoluteCurrent ( ) const

get the maximum value set for the absolute current in Amps. The experiment will end when the absolute current reaches this value.

Returns: the maximum absolute current value in Amps.

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

◆ getMaxCapacity()

double AisConstantPotElement::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.

◆ getMaxCurrent()

double AisConstantPotElement::getMaxCurrent ( ) const

get the maximum value set for the absolute current in Amps. The experiment will end when the absolute current reaches this value.

Returns: the maximum current value in Amps.

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

Attention: Deprecation Warning: This function may be modified or removed in a future version. Use getMaxAbsoluteCurrent instead.

◆ getMaxDuration()

double AisConstantPotElement::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.

◆ getMinAbsoluteCurrent()

double AisConstantPotElement::getMinAbsoluteCurrent ( ) const

get the minimum value set for the absolute current in Amps. The experiment will end when the absolute current falls down to this value.

Returns: the minimum absolute current value in Amps.

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

◆ getMinCurrent()

double AisConstantPotElement::getMinCurrent ( ) const

get the minimum value set for the absolute current in Amps. The experiment will end when the absolute current falls down to this value.

Returns: the minimum absolute current value in Amps.

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

Attention: Deprecation Warning: This function may be modified or removed in a future version. Use getMinAbsoluteCurrent instead.

◆ getMindIdt()

double AisConstantPotElement::getMindIdt ( ) const

get the value set for the minimum current rate of change with respect to time (minimum di/dt).

Returns: the value set for the minimum current rate of change with respect to time (minimum di/dt).

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

◆ getName()

QString AisConstantPotElement::getName ( ) const

override

get the name of the element.

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

◆ getPotential()

double AisConstantPotElement::getPotential ( ) const

get the value set for the potential in volts.

Returns: the value set for the potential in volts.

◆ getSamplingInterval()

double AisConstantPotElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ getVoltageRange()

int AisConstantPotElement::getVoltageRange ( ) const

get the value set for the voltage range.

Returns: the index set for the voltage range. (see AisInstrumentHandler::getManualModeVoltageRangeList())

◆ isAutoRange()

bool AisConstantPotElement::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 rage has been selected.

◆ isVoltageVsOCP()

bool AisConstantPotElement::isVoltageVsOCP ( ) const

tells whether the specified voltage is set against the open-circuit voltage or the reference terminal.

Returns: true if the specified voltage is set against the open-circuit voltage and false if it is set against the reference terminal.

See also: setVsOcp

◆ setApproxMaxCurrent()

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

◆ setAutoRange()

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

◆ setMaxAbsoluteCurrent()

void AisConstantPotElement::setMaxAbsoluteCurrent ( double maxCurrent )

set the maximum value for the absolute current in Amps.

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

Parameters

maxCurrent the maximum absolute current value in Amps.

◆ setMaxCapacity()

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

◆ setMaxCurrent()

void AisConstantPotElement::setMaxCurrent ( double maxCurrent )

set the maximum value for the absolute current in Amps.

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

Parameters

maxCurrent the maximum current value in Amps.

Attention: Deprecation Warning: This function may be modified or removed in a future version. Use setMaxAbsoluteCurrent instead.

◆ setMaxDuration()

void AisConstantPotElement::setMaxDuration ( double maxDuration )

set the maximum duration for the experiment.

This is an optional condition. If nothing is set, then the experiment will not stop based on an duration. If a maximum duration is set, the experiment will continue to run as long as the passed time is less than that value.

Parameters

maxDuration the maximum duration for the experiment in seconds.

◆ setMinAbsoluteCurrent()

void AisConstantPotElement::setMinAbsoluteCurrent ( double minCurrent )

set the minimum value for the absolute current in Amps.

This is an optional condition. If nothing is set, then the experiment will not stop based on an lower-limit current value. If a minimum absolute current is set, the experiment will continue to run as long as the measured absolute current is above that value.

Parameters

minCurrent the value to set for the minimum absolute current.

◆ setMinCurrent()

void AisConstantPotElement::setMinCurrent ( double minCurrent )

set the minimum value for the absolute current in Amps.

This is an optional condition. If nothing is set, then the experiment will not stop based on an lower-limit current value. If a minimum absolute current is set, the experiment will continue to run as long as the measured absolute current is above that value.

Parameters

minCurrent the value to set for the minimum absolute current.

Attention: Deprecation Warning: This function may be modified or removed in a future version. Use setMinAbsoluteCurrent instead.

◆ setMindIdt()

void AisConstantPotElement::setMindIdt ( double mindIdt )

set the minimum value for the current rate of change with respect to time (minimum di/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

mindIdt the minimum value for the current rate of change with respect to time (minimum di/dt).

◆ setPotential()

void AisConstantPotElement::setPotential ( double potential )

set the value for the potential in volts.

Parameters

potential the value to set for the potential in volts.

◆ setSamplingInterval()

void AisConstantPotElement::setSamplingInterval ( double samplingInterval )

set how frequently we are sampling the data.

Parameters

samplingInterval the data sampling interval value in seconds.

◆ setVoltageRange()

void AisConstantPotElement::setVoltageRange ( int idx )

manually set the voltage control range.

This is an optional parameter. If this function is not called, the device will auto-select the voltage range by default.

Parameters

idx	the corresponding voltage range index (see AisInstrumentHandler::getManualModeVoltageRangeList())

◆ setVoltageVsOCP()

void AisConstantPotElement::setVoltageVsOCP ( bool vsOCP )

set whether to reference the specified voltage against the open-circuit voltage or the reference terminal.

The reference terminal is for you to connect to any reference point you like. Connect it to the working electrode to reference ground.

Parameters

vsOCP true to set the specified voltage to reference the open-circuit voltage and false to set against the reference terminal.

The documentation for this class was generated from the following file:

AisConstantPotElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisConstantPotElement()

Member Function Documentation

◆ getApproxMaxCurrent()

◆ getCategory()

◆ getMaxAbsoluteCurrent()

◆ getMaxCapacity()

◆ getMaxCurrent()

◆ getMaxDuration()

◆ getMinAbsoluteCurrent()

◆ getMinCurrent()

◆ getMindIdt()

◆ getName()

◆ getPotential()

◆ getSamplingInterval()

◆ getVoltageRange()

◆ isAutoRange()

◆ isVoltageVsOCP()

◆ setApproxMaxCurrent()

◆ setAutoRange()

◆ setMaxAbsoluteCurrent()

◆ setMaxCapacity()

◆ setMaxCurrent()

◆ setMaxDuration()

◆ setMinAbsoluteCurrent()

◆ setMinCurrent()

◆ setMindIdt()

◆ setPotential()

◆ setSamplingInterval()

◆ setVoltageRange()

◆ setVoltageVsOCP()