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

#include <AisSteppedCurrentElement.h>

Inherits AisAbstractElement.

Public Member Functions
	AisSteppedCurrentElement (double startCurrent, double endCurrent, double stepSize, double stepDuration, double samplingInterval)
	Constructs a Stepped Current element. More...

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

AisSteppedCurrentElement &	operator= (const AisSteppedCurrentElement &)
	overload equal to operator for the AisSteppedCurrentElement 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	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	getEndCurrent () const
	Gets the ending current value for the stepped experiment. More...

double	getStepSize () const
	Gets the size of each current step in the stepped experiment. More...

double	getStartCurrent () const
	Gets the starting current value for the stepped experiment. More...

double	getStepDuration () const
	Gets the duration of each current step in the stepped experiment. More...

void	setEndCurrent (double iEnd)
	Sets the ending current value for the stepped experiment. More...

void	setStepSize (double iStep)
	Sets the size of each current step in the stepped experiment. More...

void	setStartCurrent (double iStart)
	Sets the starting current value for the stepped experiment. More...

void	setStepDuration (double tStep)
	Sets the duration of each current step in the stepped experiment. More...

double	getApproxMaxVoltage () const
	get the value set for the expected maximum voltage. More...

void	setApproxMaxVoltage (double approxMaxVoltage)
	set maximum voltage expected, for manual voltage range selection. More...

double	getApproxMinVoltage () const
	get the value set for the expected minimum voltage. More...

void	setApproxMinVoltage (double approxMinVoltage)
	set minimum voltage expected, for manual voltage range selection. More...

Detailed Description

A class representing an experiment to apply the stepped current.

Constructor & Destructor Documentation

◆ AisSteppedCurrentElement()

AisSteppedCurrentElement::AisSteppedCurrentElement	(	double	startCurrent,
		double	endCurrent,
		double	stepSize,
		double	stepDuration,
		double	samplingInterval
	)

explicit

Constructs a Stepped Current element.

This constructor initializes the Stepped Current element with the specified parameters.

Parameters

startCurrent	The initial current value in amperes.
endCurrent	The final current value in amperes.
stepSize	The size of each current step in amperes.
stepDuration	The duration of each current step in seconds.
samplingInterval	The data sampling interval value in seconds.

Member Function Documentation

◆ getApproxMaxVoltage()

double AisSteppedCurrentElement::getApproxMaxVoltage ( ) const

get the value set for the expected maximum voltage.

Returns: the value set for the expected maximum Voltage in volt.

Note: if nothing was manually set, the device will auto-select the voltage range and the return value will be positive infinity.

◆ getApproxMinVoltage()

double AisSteppedCurrentElement::getApproxMinVoltage ( ) const

get the value set for the expected minimum voltage.

Returns: the value set for the expected maximum Voltage in volt.

Note: if nothing was manually set, the device will auto-select the voltage range and the return value will be positive infinity.

◆ getCategory()

QStringList AisSteppedCurrentElement::getCategory ( ) const

override

get a list of applicable categories of the element.

Returns: A list of applicable categories: ("Galvanostatic Control").

◆ getEndCurrent()

double AisSteppedCurrentElement::getEndCurrent ( ) const

Gets the ending current value for the stepped experiment.

Returns: The ending current value in amperes.

◆ getName()

QString AisSteppedCurrentElement::getName ( ) const

override

get the name of the element.

Returns: The name of the element: "SteppedCurrent".

◆ getSamplingInterval()

double AisSteppedCurrentElement::getSamplingInterval ( ) const

get how frequently we are sampling the data.

Returns: the data sampling interval value in seconds.

◆ getStartCurrent()

double AisSteppedCurrentElement::getStartCurrent ( ) const

Gets the starting current value for the stepped experiment.

Returns: The starting current value in amperes.

◆ getStepDuration()

double AisSteppedCurrentElement::getStepDuration ( ) const

Gets the duration of each current step in the stepped experiment.

Returns: The duration of each current step in seconds.

◆ getStepSize()

double AisSteppedCurrentElement::getStepSize ( ) const

Gets the size of each current step in the stepped experiment.

Returns: The size of each current step in amperes.

◆ setApproxMaxVoltage()

void AisSteppedCurrentElement::setApproxMaxVoltage ( double approxMaxVoltage )

set maximum voltage expected, for manual voltage range selection.

This is an optional parameter. If nothing is set, the device will auto-select the voltage range.

Parameters

approxMaxVoltage the value for the maximum current expected in V.

◆ setApproxMinVoltage()

void AisSteppedCurrentElement::setApproxMinVoltage ( double approxMinVoltage )

set minimum voltage expected, for manual voltage range selection.

This is an optional parameter. If nothing is set, the device will auto-select the voltage range.

Parameters

approxMaxVoltage the value for the maximum current expected in V.

◆ setEndCurrent()

void AisSteppedCurrentElement::setEndCurrent ( double iEnd )

Sets the ending current value for the stepped experiment.

Parameters

iEnd	The ending current value in amperes.

◆ setSamplingInterval()

void AisSteppedCurrentElement::setSamplingInterval ( double samplingInterval )

set how frequently we are sampling the data.

Parameters

samplingInterval the data sampling interval value in seconds.

◆ setStartCurrent()

void AisSteppedCurrentElement::setStartCurrent ( double iStart )

Sets the starting current value for the stepped experiment.

Parameters

iStart The starting current value in amperes.

◆ setStepDuration()

void AisSteppedCurrentElement::setStepDuration ( double tStep )

Sets the duration of each current step in the stepped experiment.

Parameters

tStep The duration of each current step in seconds.

◆ setStepSize()

void AisSteppedCurrentElement::setStepSize ( double iStep )

Sets the size of each current step in the stepped experiment.

Parameters

iStep The size of each current step in amperes.

Note: Regardless of iStep's sign, the device will determine the step direction based on the start and end current.

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

AisSteppedCurrentElement.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AisSteppedCurrentElement()

Member Function Documentation

◆ getApproxMaxVoltage()

◆ getApproxMinVoltage()

◆ getCategory()

◆ getEndCurrent()

◆ getName()

◆ getSamplingInterval()

◆ getStartCurrent()

◆ getStepDuration()

◆ getStepSize()

◆ setApproxMaxVoltage()

◆ setApproxMinVoltage()

◆ setEndCurrent()

◆ setSamplingInterval()

◆ setStartCurrent()

◆ setStepDuration()

◆ setStepSize()