AisStaircasePotentialVoltammetryElement Class Reference

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

#include <AisStaircasePotentialVoltammetryElement.h>

#include <AisStaircasePotentialVoltammetryElement.h>

Public Member Functions
	AisStaircasePotentialVoltammetryElement (double startVoltage, double firstVoltageLimit, double secondVoltageLimit, double endVoltage, double stepSize, double stepDuration, double samplingInterval)
	Constructs an AisStaircasePotentialVoltammetryElement with specified parameters.
	AisStaircasePotentialVoltammetryElement (const AisStaircasePotentialVoltammetryElement &other)
	Copy constructor for AisStaircasePotentialVoltammetryElement.
AisStaircasePotentialVoltammetryElement &	operator= (const AisStaircasePotentialVoltammetryElement &other)
	Assignment operator for AisStaircasePotentialVoltammetryElement.
	~AisStaircasePotentialVoltammetryElement () override
	Destructor for AisStaircasePotentialVoltammetryElement.
QString	getName () const override
	Gets the name of the element.
QStringList	getCategory () const override
	Gets the category of the element.
double	getQuietTime () const
	Gets the quiet time duration.
void	setQuietTime (double quietTime)
	Sets the quiet time duration.
double	getQuietTimeSamplingInterval () const
	gets the quiet time sampling interval.
void	setQuietTimeSamplingInterval (double quietTimeSamplingInterval)
	Sets the quiet time sampling interval.
double	getStartVoltage () const
	Gets the starting voltage.
void	setStartVoltage (double startVoltage)
	Sets the starting voltage.
bool	isStartVoltageVsOCP () const
	Checks if the starting voltage is with respect to the open circuit mode.
void	setStartVoltageVsOCP (bool startVsOCP)
	Sets whether the starting voltage is with respect to the open circuit mode.
double	getEndVoltage () const
	Gets the ending voltage.
void	setEndVoltage (double endVoltage)
	Sets the ending voltage.
bool	isEndVoltageVsOCP () const
	Checks if the ending voltage is with respect to the open circuit mode.
void	setEndVoltageVsOCP (bool endVsOCP)
	Sets whether the ending voltage is with respect to the open circuit mode.
double	getFirstVoltageLimit () const
	Gets the first voltage limit.
void	setFirstVoltageLimit (double firstVoltageLimit)
	Sets the first voltage limit.
bool	isFirstVoltageLimitVsOCP () const
	Checks if the first voltage limit is with respect to the open circuit mode.
void	setFirstVoltageLimitVsOCP (bool firstVoltageLimitVsOCP)
	Sets whether the first voltage limit is with respect to the open circuit mode.
double	getSecondVoltageLimit () const
	Gets the second voltage limit.
void	setSecondVoltageLimit (double secondVoltageLimit)
	Sets the second voltage limit.
bool	isSecondVoltageLimitVsOCP () const
	Checks if the second voltage limit is with respect to the open circuit mode.
void	setSecondVoltageLimitVsOCP (bool secondVoltageLimitVsOCP)
	Sets whether the second voltage limit is with respect to the open circuit mode.
double	getStepSize () const
	Gets the potential step size.
void	setStepSize (double stepSize)
	Sets the potential step size.
double	getStepDuration () const
	Gets the potential step duration.
void	setStepDuration (double stepDuration)
	Sets the potential step duration.
double	getSamplingInterval () const
	Gets the potential sampling interval.
void	setSamplingInterval (double samplingInterval)
	Sets the potential sampling interval.
bool	isAutorange () const
	Checks if the experiment should autorange the current.
void	setAutorange ()
	Enables autorange for the experiment.
double	getApproxMaxCurrent () const
	Gets the approximate maximum current.
void	setApproxMaxCurrent (double approxMaxCurrent)
	Sets the approximate maximum current.
unsigned int	getNumberOfCycles ()
	get the value set for the number of cycles
void	setNumberOfCycles (unsigned int cycles)
	set the number of cycles to oscillate between the first voltage-limit and the second voltage-limit.

Constructor & Destructor Documentation

AisStaircasePotentialVoltammetryElement() [1/2]

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

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

)

Parameters

other

The AisStaircasePotentialVoltammetryElement to copy.

Member Function Documentation

getApproxMaxCurrent()

double AisStaircasePotentialVoltammetryElement::getApproxMaxCurrent

(

)

const

Returns

The approximate maximum current.

getCategory()

QStringList AisStaircasePotentialVoltammetryElement::getCategory ( ) const

override

Returns

The category of the element.

getEndVoltage()

double AisStaircasePotentialVoltammetryElement::getEndVoltage

(

)

const

Returns

The ending voltage in volts.

getFirstVoltageLimit()

double AisStaircasePotentialVoltammetryElement::getFirstVoltageLimit

(

)

const

Returns

The first voltage limit in volts.

getName()

QString AisStaircasePotentialVoltammetryElement::getName ( ) const

override

Returns

The name of the element.

getNumberOfCycles()

unsigned int AisStaircasePotentialVoltammetryElement::getNumberOfCycles

(

)

Returns

the number of cycles set.

getQuietTime()

double AisStaircasePotentialVoltammetryElement::getQuietTime

(

)

const

Returns

The quiet time duration in seconds.

getQuietTimeSamplingInterval()

double AisStaircasePotentialVoltammetryElement::getQuietTimeSamplingInterval

(

)

const

Returns

samplingInterval The quiet time sampling interval to set in seconds.

getSamplingInterval()

double AisStaircasePotentialVoltammetryElement::getSamplingInterval

(

)

const

Returns

The potential sampling interval in seconds.

getSecondVoltageLimit()

double AisStaircasePotentialVoltammetryElement::getSecondVoltageLimit

(

)

const

Returns

The second voltage limit in volts.

getStartVoltage()

double AisStaircasePotentialVoltammetryElement::getStartVoltage

(

)

const

Returns

The starting voltage in volts.

getStepDuration()

double AisStaircasePotentialVoltammetryElement::getStepDuration

(

)

const

Returns

The potential step duration in seconds.

getStepSize()

double AisStaircasePotentialVoltammetryElement::getStepSize

(

)

const

Returns

The potential step size in volts.

isAutorange()

bool AisStaircasePotentialVoltammetryElement::isAutorange

(

)

const

Returns

True if autorange is enabled, false otherwise.

isEndVoltageVsOCP()

bool AisStaircasePotentialVoltammetryElement::isEndVoltageVsOCP

(

)

const

Returns

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

isFirstVoltageLimitVsOCP()

bool AisStaircasePotentialVoltammetryElement::isFirstVoltageLimitVsOCP

(

)

const

Returns

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

isSecondVoltageLimitVsOCP()

bool AisStaircasePotentialVoltammetryElement::isSecondVoltageLimitVsOCP

(

)

const

Returns

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

isStartVoltageVsOCP()

bool AisStaircasePotentialVoltammetryElement::isStartVoltageVsOCP

(

)

const

Returns

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

operator=()

AisStaircasePotentialVoltammetryElement & AisStaircasePotentialVoltammetryElement::operator=

(

const AisStaircasePotentialVoltammetryElement &

other

)

Parameters

other

The AisStaircasePotentialVoltammetryElement to assign.

Returns

Reference to this AisStaircasePotentialVoltammetryElement.

setApproxMaxCurrent()

void AisStaircasePotentialVoltammetryElement::setApproxMaxCurrent

(

double

approxMaxCurrent

)

Parameters

approxMaxCurrent

The approximate maximum current to set.

setEndVoltage()

void AisStaircasePotentialVoltammetryElement::setEndVoltage

(

double

endVoltage

)

Parameters

endVoltage

The ending voltage to set in volts.

setEndVoltageVsOCP()

void AisStaircasePotentialVoltammetryElement::setEndVoltageVsOCP

(

bool

endVsOCP

)

Parameters

endVsOCP

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

setFirstVoltageLimit()

void AisStaircasePotentialVoltammetryElement::setFirstVoltageLimit

(

double

firstVoltageLimit

)

Parameters

firstVoltageLimit

The first voltage limit to set in volts.

setFirstVoltageLimitVsOCP()

void AisStaircasePotentialVoltammetryElement::setFirstVoltageLimitVsOCP

(

bool

firstVoltageLimitVsOCP

)

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

)

Parameters

cycles

the number of cycles to set

setQuietTime()

void AisStaircasePotentialVoltammetryElement::setQuietTime

(

double

quietTime

)

Parameters

quietTime

The quiet time duration to set in seconds.

setQuietTimeSamplingInterval()

void AisStaircasePotentialVoltammetryElement::setQuietTimeSamplingInterval

(

double

quietTimeSamplingInterval

)

Parameters

quietTimeSamplingInterval

The quiet time sampling interval to set in seconds.

setSamplingInterval()

void AisStaircasePotentialVoltammetryElement::setSamplingInterval

(

double

samplingInterval

)

Parameters

samplingInterval

The potential sampling interval to set in seconds.

setSecondVoltageLimit()

void AisStaircasePotentialVoltammetryElement::setSecondVoltageLimit

(

double

secondVoltageLimit

)

Parameters

secondVoltageLimit

The second voltage limit to set in volts.

setSecondVoltageLimitVsOCP()

void AisStaircasePotentialVoltammetryElement::setSecondVoltageLimitVsOCP

(

bool

secondVoltageLimitVsOCP

)

Parameters

secondVoltageLimitVsOCP

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

setStartVoltage()

void AisStaircasePotentialVoltammetryElement::setStartVoltage

(

double

startVoltage

)

Parameters

startVoltage

The starting voltage to set in volts.

setStartVoltageVsOCP()

void AisStaircasePotentialVoltammetryElement::setStartVoltageVsOCP

(

bool

startVsOCP

)

Parameters

startVsOCP

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

setStepDuration()

void AisStaircasePotentialVoltammetryElement::setStepDuration

(

double

stepDuration

)

Parameters

stepDuration

The potential step duration to set in seconds.

setStepSize()

void AisStaircasePotentialVoltammetryElement::setStepSize

(

double

stepSize

)

Parameters

stepSize

The potential step size to set in volts.

---

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

• AisStaircasePotentialVoltammetryElement.h