AisSteppedVoltageElement Class Reference

A class representing an experiment to apply the stepped volatge. More...

#include <AisSteppedVoltageElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisSteppedVoltageElement (double startVoltage, double endVoltage, double voltageStep, double voltageStepDuration, double samplingInterval)
	Constructor for the AisSteppedVoltageElement element. More...
	AisSteppedVoltageElement (const AisSteppedVoltageElement &other)
	Copy constructor for the AisSteppedVoltageElement object. More...
AisSteppedVoltageElement &	operator= (const AisSteppedVoltageElement &other)
	Overloaded assignment operator for the AisSteppedVoltageElement object. More...
	~AisSteppedVoltageElement () override
	Destructor for the AisSteppedVoltageElement 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	getStartVoltage () const
	Get the starting voltage for the experiment. More...
double	getEndVoltage () const
	Get the ending voltage for the experiment. More...
double	getStepSize () const
	Get the voltage step for each iteration. More...
double	getStepDuration () const
	Get the time step for each iteration. More...
double	getSamplingInterval () const
	Get the data sampling interval. More...
double	getApproxMaxCurrent () const
	Get the approximate maximum current. More...
bool	isStartVoltageVsOCP () const
	Check if the experiment starts with the open circuit potential. More...
bool	isEndVoltageVsOCP () const
	Check if the experiment ends with the open circuit potential. More...
bool	isAutoRange () const
	Check if current autoranging is enabled. More...
void	setStartVoltage (double vStart)
	Set the starting voltage for the experiment. More...
void	setEndVoltage (double vEnd)
	Set the ending voltage for the experiment. More...
void	setStepSize (double vStep)
	Set the voltage step for each iteration. More...
void	setStepDuration (double duration)
	Set the time step for each iteration. More...
void	setSamplingInterval (double samplingInterval)
	Set the data sampling interval. More...
void	setApproxMaxCurrent (double approxMaxCurrent)
	Set the approximate maximum current. More...
void	setStartVoltageVsOCP (bool startVsOCP)
	Set whether the experiment starts with the open circuit potential. More...
void	setEndVoltageVsOCP (bool endVsOCP)
	Set whether the experiment ends with the open circuit potential. More...
void	setCurrentAutorange ()
	Enable current autoranging for the experiment.

Detailed Description

A class representing an experiment to apply the stepped volatge.

This class inherits from AisAbstractElement and is designed for Stepped Voltage experiments.

Constructor & Destructor Documentation

AisSteppedVoltageElement() [1/2]

AisSteppedVoltageElement::AisSteppedVoltageElement ( double  startVoltage, double  endVoltage, double  voltageStep, double  voltageStepDuration, double  samplingInterval  )

explicit

Constructor for the AisSteppedVoltageElement element.

This constructor initializes the AisSteppedVoltageElement element with the specified parameters.

Parameters

startVoltage	The initial voltage value in volts.
endVoltage	The final voltage value in volts.
voltageStep	The size of each voltage step in volts.
voltageStepDuration	The duration of each voltage step in seconds.
samplingInterval	The data sampling interval value in seconds.

AisSteppedVoltageElement() [2/2]

AisSteppedVoltageElement::AisSteppedVoltageElement ( const AisSteppedVoltageElement &  other )

explicit

Copy constructor for the AisSteppedVoltageElement object.

Parameters

other

The AisSteppedVoltageElement object to be copied.

Member Function Documentation

getApproxMaxCurrent()

double AisSteppedVoltageElement::getApproxMaxCurrent

(

)

const

Get the approximate maximum current.

Returns

The approximate maximum current in Amps.

getCategory()

QStringList AisSteppedVoltageElement::getCategory ( ) const

override

Get a list of applicable categories of the element.

Returns

A list of applicable categories: ("Potentiostatic Control").

getEndVoltage()

double AisSteppedVoltageElement::getEndVoltage

(

)

const

Get the ending voltage for the experiment.

Returns

The ending voltage in volts.

getName()

QString AisSteppedVoltageElement::getName ( ) const

override

Get the name of the element.

Returns

The name of the element: "Stepped Voltage".

getSamplingInterval()

double AisSteppedVoltageElement::getSamplingInterval

(

)

const

Get the data sampling interval.

Returns

The data sampling interval in seconds.

getStartVoltage()

double AisSteppedVoltageElement::getStartVoltage

(

)

const

Get the starting voltage for the experiment.

Returns

The starting voltage in volts.

getStepDuration()

double AisSteppedVoltageElement::getStepDuration

(

)

const

Get the time step for each iteration.

Returns

The time step in seconds.

getStepSize()

double AisSteppedVoltageElement::getStepSize

(

)

const

Get the voltage step for each iteration.

Returns

The voltage step in volts.

isAutoRange()

bool AisSteppedVoltageElement::isAutoRange

(

)

const

Check if current autoranging is enabled.

Returns

True if current autoranging is enabled, false otherwise.

isEndVoltageVsOCP()

bool AisSteppedVoltageElement::isEndVoltageVsOCP

(

)

const

Check if the experiment ends with the open circuit potential.

Returns

True if the experiment ends with open circuit potential, false otherwise.

isStartVoltageVsOCP()

bool AisSteppedVoltageElement::isStartVoltageVsOCP

(

)

const

Check if the experiment starts with the open circuit potential.

Returns

True if the experiment starts with open circuit potential, false otherwise.

operator=()

AisSteppedVoltageElement & AisSteppedVoltageElement::operator=

(

const AisSteppedVoltageElement &

other

)

Overloaded assignment operator for the AisSteppedVoltageElement object.

Parameters

other

The AisSteppedVoltageElement object to be assigned.

Returns

A reference to the assigned AisSteppedVoltageElement object.

setApproxMaxCurrent()

void AisSteppedVoltageElement::setApproxMaxCurrent

(

double

approxMaxCurrent

)

Set the approximate maximum current.

Parameters

approxMaxCurrent

The approximate maximum current in Amps.

setEndVoltage()

void AisSteppedVoltageElement::setEndVoltage

(

double

vEnd

)

Set the ending voltage for the experiment.

Parameters

vEnd	The ending voltage in volts.

setEndVoltageVsOCP()

void AisSteppedVoltageElement::setEndVoltageVsOCP

(

bool

endVsOCP

)

Set whether the experiment ends with the open circuit potential.

Parameters

endVsOCP

True to end with open circuit potential, false otherwise.

setSamplingInterval()

void AisSteppedVoltageElement::setSamplingInterval

(

double

samplingInterval

)

Set the data sampling interval.

Parameters

samplingInterval

The data sampling interval in seconds.

setStartVoltage()

void AisSteppedVoltageElement::setStartVoltage

(

double

vStart

)

Set the starting voltage for the experiment.

Parameters

vStart

The starting voltage in volts.

setStartVoltageVsOCP()

void AisSteppedVoltageElement::setStartVoltageVsOCP

(

bool

startVsOCP

)

Set whether the experiment starts with the open circuit potential.

Parameters

startVsOCP

True to start with open circuit potential, false otherwise.

setStepDuration()

void AisSteppedVoltageElement::setStepDuration

(

double

duration

)

Set the time step for each iteration.

Parameters

tStep

The time step in seconds.

setStepSize()

void AisSteppedVoltageElement::setStepSize

(

double

vStep

)

Set the voltage step for each iteration.

Parameters

vStep

The voltage step in volts.

Note

Regardless of vStep's sign, the device will determine the step direction based on the start and end voltage.

---

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

• AisSteppedVoltageElement.h