This element/experiment simulates a constant resistance load.
More...

#include <AisConstantResistanceElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisConstantResistanceElement (double resistance, double duration, double samplingInterval)
	the constant resistance element constructor. More...

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

AisConstantResistanceElement &	operator= (const AisConstantResistanceElement &)
	overload equal to operator for the AisConstantResistanceElement 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	getResistance () const
	get the value set for the resistance as a load. More...

void	setResistance (double resistance)
	set the value for the resistance as a load 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	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...

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

void	setMinimumVoltageVsOCP (bool vsOCP)
	set whether to reference the specified minimum voltage against the open-circuit voltage or the reference terminal. More...

double	getMaxVoltage () const
	get the value set maximum for the voltage in volts. More...

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

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

void	setMaximumVoltageVsOCP (bool vsOCP)
	set whether to reference the specified maximum voltage against the open-circuit voltage or the reference terminal. More...

double	getMaxCurrent () const
	get the value set maximum for the current in amps. More...

void	setMaxCurrent (double maxCurrent)
	set a maximum current to stop the experiment. More...

double	getMinCurrent () const
	get the value set minimum for the current in amps. More...

void	setMinCurrent (double maxCurrent)
	set a minimum current 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...

Detailed Description

This element/experiment simulates a constant resistance load.

Constructor & Destructor Documentation

◆ AisConstantResistanceElement()

AisConstantResistanceElement::AisConstantResistanceElement	(	double	resistance,
		double	duration,
		double	samplingInterval
	)

explicit

the constant resistance element constructor.

Parameters

resistance	the value in ohm of the load resistance
duration	the maximum duration for the experiment in seconds.
samplingInterval	the data sampling interval value in seconds.

Member Function Documentation

◆ getCategory()

QStringList AisConstantResistanceElement::getCategory ( ) const

override

get a list of applicable categories of the element.

Returns: A list of applicable categories: ("Energy Storage", "Charge/Discharge").

◆ getMaxCapacity()

double AisConstantResistanceElement::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 AisConstantResistanceElement::getMaxCurrent ( ) const

get the value set maximum for the current in amps.

Returns: the value set for the maximum current in amps.

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

◆ getMaxDuration()

double AisConstantResistanceElement::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 AisConstantResistanceElement::getMaxVoltage ( ) const

get the value set maximum for the voltage in volts.

Returns: the value set for the maximum voltage in volts.

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

◆ getMinCurrent()

double AisConstantResistanceElement::getMinCurrent ( ) const

get the value set minimum for the current in amps.

Returns: the value set for the minimum current in amps.

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

◆ getMinVoltage()

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

override

get the name of the element.

Returns: The name of the element: "Constant Resistance".

◆ getResistance()

double AisConstantResistanceElement::getResistance ( ) const

get the value set for the resistance as a load.

Returns: the value in ohm of the load resistance.

◆ getSamplingInterval()

double AisConstantResistanceElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ isMaximumVoltageVsOCP()

bool AisConstantResistanceElement::isMaximumVoltageVsOCP ( ) const

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

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

See also: setVsOcp

◆ isMinimumVoltageVsOCP()

bool AisConstantResistanceElement::isMinimumVoltageVsOCP ( ) const

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

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

See also: setVsOcp

◆ setMaxCapacity()

void AisConstantResistanceElement::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 AisConstantResistanceElement::setMaxCurrent ( double maxCurrent )

set a maximum current to stop the experiment.

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

Parameters

maxCurrent the maximum current value in amps at which the experiment will stop.

◆ setMaxDuration()

void AisConstantResistanceElement::setMaxDuration ( double maxDuration )

set the maximum duration for the experiment.

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

Parameters

maxDuration the maximum duration for the experiment in seconds.

◆ setMaximumVoltageVsOCP()

void AisConstantResistanceElement::setMaximumVoltageVsOCP ( bool vsOCP )

set whether to reference the specified maximum 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 maximum voltage to reference the open-circuit voltage and false to set against the reference terminal.

◆ setMaxVoltage()

void AisConstantResistanceElement::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 above that value.

Parameters

minVoltage the maximum voltage value in volts at which the experiment will stop.

◆ setMinCurrent()

void AisConstantResistanceElement::setMinCurrent ( double maxCurrent )

set a minimum current to stop the experiment.

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 current is set, the experiment will continue to run as long as the measured current is below that value.

Parameters

maxCurrent the minimum current value in amps at which the experiment will stop.

◆ setMinimumVoltageVsOCP()

void AisConstantResistanceElement::setMinimumVoltageVsOCP ( bool vsOCP )

set whether to reference the specified minimum 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 minimum voltage to reference the open-circuit voltage and false to set against the reference terminal.

◆ setMinVoltage()

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

◆ setResistance()

void AisConstantResistanceElement::setResistance ( double resistance )

set the value for the resistance as a load

Parameters

resistance the value in ohm of the load resistance.

◆ setSamplingInterval()

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

AisConstantResistanceElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisConstantResistanceElement()

Member Function Documentation

◆ getCategory()

◆ getMaxCapacity()

◆ getMaxCurrent()

◆ getMaxDuration()

◆ getMaxVoltage()

◆ getMinCurrent()

◆ getMinVoltage()

◆ getName()

◆ getResistance()

◆ getSamplingInterval()

◆ isMaximumVoltageVsOCP()

◆ isMinimumVoltageVsOCP()

◆ setMaxCapacity()

◆ setMaxCurrent()

◆ setMaxDuration()

◆ setMaximumVoltageVsOCP()

◆ setMaxVoltage()

◆ setMinCurrent()

◆ setMinimumVoltageVsOCP()

◆ setMinVoltage()

◆ setResistance()

◆ setSamplingInterval()