This experiment simulates a constant power, charge or discharge".
More...

#include <AisConstantPowerElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisConstantPowerElement (double power, double duration, double samplingInterval)
	the constant power element constructor More...

	AisConstantPowerElement (bool isCharge, double power, double duration, double samplingInterval)
	the constant power element constructor that supports the isCharge parameter More...

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

AisConstantPowerElement &	operator= (const AisConstantPowerElement &)
	overload equal to operator for the AisConstantPowerElement 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...

bool	isCharge () const
	tells whether the experiment is set to simulate charge or discharge. More...

void	setCharge (bool isCharge)
	set whether the experiment is to simulate charge or discharge. More...

double	getPower () const
	get the value set for the power. More...

void	setPower (double power)
	set the value for the power. 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	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...

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	getMinVoltage () const
	get the minimum value set for the voltage in volts. The experiment will end when it reaches down this value. More...

void	setMinVoltage (double minVoltage)
	set a minimum value for the voltage. The experiment will end when it reaches down this value. 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	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 experiment simulates a constant power, charge or discharge".

Constructor & Destructor Documentation

◆ AisConstantPowerElement() [1/2]

AisConstantPowerElement::AisConstantPowerElement	(	double	power,
		double	duration,
		double	samplingInterval
	)

explicit

the constant power element constructor

Parameters

power	the value set for the power in watts.
duration	the maximum duration for the experiment in seconds.
samplingInterval	the data sampling interval value in seconds.

◆ AisConstantPowerElement() [2/2]

AisConstantPowerElement::AisConstantPowerElement	(	bool	isCharge,
		double	power,
		double	duration,
		double	samplingInterval
	)

explicit

the constant power element constructor that supports the isCharge parameter

Parameters

isCharge	true to set the experiment simulate charge and false to simulate discharge.
power	the value set for the power in watts.
duration	the maximum duration for the experiment in seconds.
samplingInterval	the data sampling interval value in seconds.

Attention: Deprecation Warning: the isCharge parameter will be deprecated in a future version. Using the alternative constructor is highly recommended to avoid compilation errors in a future version. If this constructor is used, the sign of the power will be ignored and isCharge state will be used to determine it instead.

Member Function Documentation

◆ getCategory()

QStringList AisConstantPowerElement::getCategory ( ) const

override

get a list of applicable categories of the element.

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

◆ getMaxCapacity()

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

◆ getMinCurrent()

double AisConstantPowerElement::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 AisConstantPowerElement::getMinVoltage ( ) const

get the minimum value set for the voltage in volts. The experiment will end when it reaches down this value.

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

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

◆ getName()

QString AisConstantPowerElement::getName ( ) const

override

get the name of the element.

Returns: The name of the element: "Constant Power Charge/Discharge".

◆ getPower()

double AisConstantPowerElement::getPower ( ) const

get the value set for the power.

Returns: the value set for the power in watts.

◆ getSamplingInterval()

double AisConstantPowerElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ isCharge()

bool AisConstantPowerElement::isCharge ( ) const

tells whether the experiment is set to simulate charge or discharge.

Returns: true if the experiment is set to simulate charge and false if it is set to simulate discharge.

◆ isMaximumVoltageVsOCP()

bool AisConstantPowerElement::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 AisConstantPowerElement::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

◆ setCharge()

void AisConstantPowerElement::setCharge ( bool isCharge )

set whether the experiment is to simulate charge or discharge.

Parameters

isCharge if the given argument is true, the experiment will simulate charge and discharge if given false.

Attention: Deprecation Warning: setCharge will be deprecated in a future version. Avoid using this function, and instead set the power to a positive or negative value. If AisConstantPowerElement(bool, double, double, double) is used, you must use this function to set the charge/discharge state.

◆ setMaxCapacity()

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

◆ setMinCurrent()

void AisConstantPowerElement::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 AisConstantPowerElement::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 AisConstantPowerElement::setMinVoltage ( double minVoltage )

set a minimum value for the voltage. The experiment will end when it reaches down this value.

Parameters

minVoltage the value for the voltage in volts.

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

◆ setPower()

void AisConstantPowerElement::setPower ( double power )

set the value for the power.

Parameters

power the value set for the power in watts.

◆ setSamplingInterval()

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

AisConstantPowerElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisConstantPowerElement() [1/2]

◆ AisConstantPowerElement() [2/2]

Member Function Documentation

◆ getCategory()

◆ getMaxCapacity()

◆ getMaxCurrent()

◆ getMaxDuration()

◆ getMaxVoltage()

◆ getMinCurrent()

◆ getMinVoltage()

◆ getName()

◆ getPower()

◆ getSamplingInterval()

◆ isCharge()

◆ isMaximumVoltageVsOCP()

◆ isMinimumVoltageVsOCP()

◆ setCharge()

◆ setMaxCapacity()

◆ setMaxCurrent()

◆ setMaxDuration()

◆ setMaximumVoltageVsOCP()

◆ setMaxVoltage()

◆ setMinCurrent()

◆ setMinimumVoltageVsOCP()

◆ setMinVoltage()

◆ setPower()

◆ setSamplingInterval()