AisStaircasePotentialVoltammetryElement class represents an element for staircase potential voltammetry experiments. It inherits from AisAbstractElement. More...

#include <AisStaircasePotentialVoltammetryElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisStaircasePotentialVoltammetryElement (double startVoltage, double firstVoltageLimit, double secondVoltageLimit, double endVoltage, double stepSize, double stepDuration, double samplingInterval)
	Constructs an AisStaircasePotentialVoltammetryElement with specified parameters. More...

	AisStaircasePotentialVoltammetryElement (const AisStaircasePotentialVoltammetryElement &other)
	Copy constructor for AisStaircasePotentialVoltammetryElement. More...

AisStaircasePotentialVoltammetryElement &	operator= (const AisStaircasePotentialVoltammetryElement &other)
	Assignment operator for AisStaircasePotentialVoltammetryElement. More...

	~AisStaircasePotentialVoltammetryElement () override
	Destructor for AisStaircasePotentialVoltammetryElement.

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

QStringList	getCategory () const override
	Gets the category of the element. More...

double	getQuietTime () const
	Gets the quiet time duration. More...

void	setQuietTime (double quietTime)
	Sets the quiet time duration. More...

double	getQuietTimeSamplingInterval () const
	gets the quiet time sampling interval. More...

void	setQuietTimeSamplingInterval (double quietTimeSamplingInterval)
	Sets the quiet time sampling interval. More...

double	getStartVoltage () const
	Gets the starting voltage. More...

void	setStartVoltage (double startVoltage)
	Sets the starting voltage. More...

bool	isStartVoltageVsOCP () const
	Checks if the starting voltage is with respect to the open circuit mode. More...

void	setStartVoltageVsOCP (bool startVsOCP)
	Sets whether the starting voltage is with respect to the open circuit mode. More...

double	getEndVoltage () const
	Gets the ending voltage. More...

void	setEndVoltage (double endVoltage)
	Sets the ending voltage. More...

bool	isEndVoltageVsOCP () const
	Checks if the ending voltage is with respect to the open circuit mode. More...

void	setEndVoltageVsOCP (bool endVsOCP)
	Sets whether the ending voltage is with respect to the open circuit mode. More...

double	getFirstVoltageLimit () const
	Gets the first voltage limit. More...

void	setFirstVoltageLimit (double firstVoltageLimit)
	Sets the first voltage limit. More...

bool	isFirstVoltageLimitVsOCP () const
	Checks if the first voltage limit is with respect to the open circuit mode. More...

void	setFirstVoltageLimitVsOCP (bool firstVoltageLimitVsOCP)
	Sets whether the first voltage limit is with respect to the open circuit mode. More...

double	getSecondVoltageLimit () const
	Gets the second voltage limit. More...

void	setSecondVoltageLimit (double secondVoltageLimit)
	Sets the second voltage limit. More...

bool	isSecondVoltageLimitVsOCP () const
	Checks if the second voltage limit is with respect to the open circuit mode. More...

void	setSecondVoltageLimitVsOCP (bool secondVoltageLimitVsOCP)
	Sets whether the second voltage limit is with respect to the open circuit mode. More...

double	getStepSize () const
	Gets the potential step size. More...

void	setStepSize (double stepSize)
	Sets the potential step size. More...

double	getStepDuration () const
	Gets the potential step duration. More...

void	setStepDuration (double stepDuration)
	Sets the potential step duration. More...

double	getSamplingInterval () const
	Gets the potential sampling interval. More...

void	setSamplingInterval (double samplingInterval)
	Sets the potential sampling interval. More...

bool	isAutorange () const
	Checks if the experiment should autorange the current. More...

void	setAutorange ()
	Enables autorange for the experiment.

double	getApproxMaxCurrent () const
	Gets the approximate maximum current. More...

void	setApproxMaxCurrent (double approxMaxCurrent)
	Sets the approximate maximum current. More...

unsigned int	getNumberOfCycles ()
	get the value set for the number of cycles More...

void	setNumberOfCycles (unsigned int cycles)
	set the number of cycles to oscillate between the first voltage-limit and the second voltage-limit. More...

Detailed Description

AisStaircasePotentialVoltammetryElement class represents an element for staircase potential voltammetry experiments. It inherits from AisAbstractElement.

Constructor & Destructor Documentation

◆ AisStaircasePotentialVoltammetryElement() [1/2]

AisStaircasePotentialVoltammetryElement::AisStaircasePotentialVoltammetryElement	(	double	startVoltage,
		double	firstVoltageLimit,
		double	secondVoltageLimit,
		double	endVoltage,
		double	stepSize,
		double	stepDuration,
		double	samplingInterval
	)

Constructs an AisStaircasePotentialVoltammetryElement with specified parameters.

Parameters

startVoltage	The starting voltage in volts.
firstVoltageLimit	The first voltage limit in volts.
secondVoltageLimit	The second voltage limit in volts.
endVoltage	The ending voltage in volts.
stepSize	The potential step size in volts.
stepDuration	The potential step duration in seconds.
samplingInterval	The potential sampling interval in seconds.

◆ AisStaircasePotentialVoltammetryElement() [2/2]

AisStaircasePotentialVoltammetryElement::AisStaircasePotentialVoltammetryElement ( const AisStaircasePotentialVoltammetryElement & other )

Copy constructor for AisStaircasePotentialVoltammetryElement.

Parameters

other The AisStaircasePotentialVoltammetryElement to copy.

Member Function Documentation

◆ getApproxMaxCurrent()

double AisStaircasePotentialVoltammetryElement::getApproxMaxCurrent ( ) const

Gets the approximate maximum current.

Returns: The approximate maximum current.

◆ getCategory()

QStringList AisStaircasePotentialVoltammetryElement::getCategory ( ) const

override

Gets the category of the element.

Returns: The category of the element.

◆ getEndVoltage()

double AisStaircasePotentialVoltammetryElement::getEndVoltage ( ) const

Gets the ending voltage.

Returns: The ending voltage in volts.

◆ getFirstVoltageLimit()

double AisStaircasePotentialVoltammetryElement::getFirstVoltageLimit ( ) const

Gets the first voltage limit.

Returns: The first voltage limit in volts.

◆ getName()

QString AisStaircasePotentialVoltammetryElement::getName ( ) const

override

Gets the name of the element.

Returns: The name of the element.

◆ getNumberOfCycles()

unsigned int AisStaircasePotentialVoltammetryElement::getNumberOfCycles ( )

get the value set for the number of cycles

Returns: the number of cycles set.

◆ getQuietTime()

double AisStaircasePotentialVoltammetryElement::getQuietTime ( ) const

Gets the quiet time duration.

Returns: The quiet time duration in seconds.

◆ getQuietTimeSamplingInterval()

double AisStaircasePotentialVoltammetryElement::getQuietTimeSamplingInterval ( ) const

gets the quiet time sampling interval.

Returns: samplingInterval The quiet time sampling interval to set in seconds.

◆ getSamplingInterval()

double AisStaircasePotentialVoltammetryElement::getSamplingInterval ( ) const

Gets the potential sampling interval.

Returns: The potential sampling interval in seconds.

◆ getSecondVoltageLimit()

double AisStaircasePotentialVoltammetryElement::getSecondVoltageLimit ( ) const

Gets the second voltage limit.

Returns: The second voltage limit in volts.

◆ getStartVoltage()

double AisStaircasePotentialVoltammetryElement::getStartVoltage ( ) const

Gets the starting voltage.

Returns: The starting voltage in volts.

◆ getStepDuration()

double AisStaircasePotentialVoltammetryElement::getStepDuration ( ) const

Gets the potential step duration.

Returns: The potential step duration in seconds.

◆ getStepSize()

double AisStaircasePotentialVoltammetryElement::getStepSize ( ) const

Gets the potential step size.

Returns: The potential step size in volts.

◆ isAutorange()

bool AisStaircasePotentialVoltammetryElement::isAutorange ( ) const

Checks if the experiment should autorange the current.

Returns: True if autorange is enabled, false otherwise.

◆ isEndVoltageVsOCP()

bool AisStaircasePotentialVoltammetryElement::isEndVoltageVsOCP ( ) const

Checks if the ending voltage is with respect to the open circuit mode.

Returns: True if the ending voltage is with respect to the open circuit mode, false otherwise.

◆ isFirstVoltageLimitVsOCP()

bool AisStaircasePotentialVoltammetryElement::isFirstVoltageLimitVsOCP ( ) const

Checks if the first voltage limit is with respect to the open circuit mode.

Returns: True if the first voltage limit is with respect to the open circuit mode, false otherwise.

◆ isSecondVoltageLimitVsOCP()

bool AisStaircasePotentialVoltammetryElement::isSecondVoltageLimitVsOCP ( ) const

Checks if the second voltage limit is with respect to the open circuit mode.

Returns: True if the second voltage limit is with respect to the open circuit mode, false otherwise.

◆ isStartVoltageVsOCP()

bool AisStaircasePotentialVoltammetryElement::isStartVoltageVsOCP ( ) const

Checks if the starting voltage is with respect to the open circuit mode.

Returns: True if the starting voltage is with respect to the open circuit mode, false otherwise.

◆ operator=()

AisStaircasePotentialVoltammetryElement & AisStaircasePotentialVoltammetryElement::operator= ( const AisStaircasePotentialVoltammetryElement & other )

Assignment operator for AisStaircasePotentialVoltammetryElement.

Parameters

other The AisStaircasePotentialVoltammetryElement to assign.

Returns: Reference to this AisStaircasePotentialVoltammetryElement.

◆ setApproxMaxCurrent()

void AisStaircasePotentialVoltammetryElement::setApproxMaxCurrent ( double approxMaxCurrent )

Sets the approximate maximum current.

Parameters

approxMaxCurrent The approximate maximum current to set.

◆ setEndVoltage()

void AisStaircasePotentialVoltammetryElement::setEndVoltage ( double endVoltage )

Sets the ending voltage.

Parameters

endVoltage The ending voltage to set in volts.

◆ setEndVoltageVsOCP()

void AisStaircasePotentialVoltammetryElement::setEndVoltageVsOCP ( bool endVsOCP )

Sets whether the ending voltage is with respect to the open circuit mode.

Parameters

endVsOCP True to set the ending voltage with respect to the open circuit mode, false otherwise.

◆ setFirstVoltageLimit()

void AisStaircasePotentialVoltammetryElement::setFirstVoltageLimit ( double firstVoltageLimit )

Sets the first voltage limit.

Parameters

firstVoltageLimit The first voltage limit to set in volts.

◆ setFirstVoltageLimitVsOCP()

void AisStaircasePotentialVoltammetryElement::setFirstVoltageLimitVsOCP ( bool firstVoltageLimitVsOCP )

Sets whether the first voltage limit is with respect to the open circuit mode.

Parameters

firstVoltageLimitVsOCP True to set the first voltage limit with respect to the open circuit mode, false otherwise.

◆ setNumberOfCycles()

void AisStaircasePotentialVoltammetryElement::setNumberOfCycles ( unsigned int cycles )

set the number of cycles to oscillate between the first voltage-limit and the second voltage-limit.

Parameters

cycles the number of cycles to set

◆ setQuietTime()

void AisStaircasePotentialVoltammetryElement::setQuietTime ( double quietTime )

Sets the quiet time duration.

Parameters

quietTime The quiet time duration to set in seconds.

◆ setQuietTimeSamplingInterval()

void AisStaircasePotentialVoltammetryElement::setQuietTimeSamplingInterval ( double quietTimeSamplingInterval )

Sets the quiet time sampling interval.

Parameters

quietTimeSamplingInterval The quiet time sampling interval to set in seconds.

◆ setSamplingInterval()

void AisStaircasePotentialVoltammetryElement::setSamplingInterval ( double samplingInterval )

Sets the potential sampling interval.

Parameters

samplingInterval The potential sampling interval to set in seconds.

◆ setSecondVoltageLimit()

void AisStaircasePotentialVoltammetryElement::setSecondVoltageLimit ( double secondVoltageLimit )

Sets the second voltage limit.

Parameters

secondVoltageLimit The second voltage limit to set in volts.

◆ setSecondVoltageLimitVsOCP()

void AisStaircasePotentialVoltammetryElement::setSecondVoltageLimitVsOCP ( bool secondVoltageLimitVsOCP )

Sets whether the second voltage limit is with respect to the open circuit mode.

Parameters

secondVoltageLimitVsOCP True to set the second voltage limit with respect to the open circuit mode, false otherwise.

◆ setStartVoltage()

void AisStaircasePotentialVoltammetryElement::setStartVoltage ( double startVoltage )

Sets the starting voltage.

Parameters

startVoltage The starting voltage to set in volts.

◆ setStartVoltageVsOCP()

void AisStaircasePotentialVoltammetryElement::setStartVoltageVsOCP ( bool startVsOCP )

Sets whether the starting voltage is with respect to the open circuit mode.

Parameters

startVsOCP True to set the starting voltage with respect to the open circuit mode, false otherwise.

◆ setStepDuration()

void AisStaircasePotentialVoltammetryElement::setStepDuration ( double stepDuration )

Sets the potential step duration.

Parameters

stepDuration The potential step duration to set in seconds.

◆ setStepSize()

void AisStaircasePotentialVoltammetryElement::setStepSize ( double stepSize )

Sets the potential step size.

Parameters

stepSize The potential step size to set in volts.

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

AisStaircasePotentialVoltammetryElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisStaircasePotentialVoltammetryElement() [1/2]

◆ AisStaircasePotentialVoltammetryElement() [2/2]

Member Function Documentation

◆ getApproxMaxCurrent()

◆ getCategory()

◆ getEndVoltage()

◆ getFirstVoltageLimit()

◆ getName()

◆ getNumberOfCycles()

◆ getQuietTime()

◆ getQuietTimeSamplingInterval()

◆ getSamplingInterval()

◆ getSecondVoltageLimit()

◆ getStartVoltage()

◆ getStepDuration()

◆ getStepSize()

◆ isAutorange()

◆ isEndVoltageVsOCP()

◆ isFirstVoltageLimitVsOCP()

◆ isSecondVoltageLimitVsOCP()

◆ isStartVoltageVsOCP()

◆ operator=()

◆ setApproxMaxCurrent()

◆ setEndVoltage()

◆ setEndVoltageVsOCP()

◆ setFirstVoltageLimit()

◆ setFirstVoltageLimitVsOCP()

◆ setNumberOfCycles()

◆ setQuietTime()

◆ setQuietTimeSamplingInterval()

◆ setSamplingInterval()

◆ setSecondVoltageLimit()

◆ setSecondVoltageLimitVsOCP()

◆ setStartVoltage()

◆ setStartVoltageVsOCP()

◆ setStepDuration()

◆ setStepSize()