AisSteppedCurrentElement Class Reference

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

#include <AisSteppedCurrentElement.h>

#include <AisSteppedCurrentElement.h>

Public Member Functions
	AisSteppedCurrentElement (double startCurrent, double endCurrent, double stepSize, double stepDuration, double samplingInterval)
	Constructs a Stepped Current element.
	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.
QStringList	getCategory () const override
	get a list of applicable categories of the element.
double	getSamplingInterval () const
	get how frequently we are sampling the data.
void	setSamplingInterval (double samplingInterval)
	set how frequently we are sampling the data.
double	getEndCurrent () const
	Gets the ending current value for the stepped experiment.
void	setEndCurrent (double iEnd)
	Sets the ending current value for the stepped experiment.
double	getStepSize () const
	Gets the size of each current step in the stepped experiment.
void	setStepSize (double iStep)
	Sets the size of each current step in the stepped experiment.
double	getStartCurrent () const
	Gets the starting current value for the stepped experiment.
void	setStartCurrent (double iStart)
	Sets the starting current value for the stepped experiment.
double	getStepDuration () const
	Gets the duration of each current step in the stepped experiment.
void	setStepDuration (double tStep)
	Sets the duration of each current step in the stepped experiment.
double	getApproxMaxVoltage () const
	get the value set for the expected maximum voltage.
void	setApproxMaxVoltage (double approxMaxVoltage)
	set maximum voltage expected, for manual voltage range selection.
double	getApproxMinVoltage () const
	get the value set for the expected minimum voltage.
void	setApproxMinVoltage (double approxMinVoltage)
	set minimum voltage expected, for manual voltage range selection.

Constructor & Destructor Documentation

AisSteppedCurrentElement()

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

explicit

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

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

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

Returns

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

getEndCurrent()

double AisSteppedCurrentElement::getEndCurrent

(

)

const

Returns

The ending current value in amperes.

getName()

QString AisSteppedCurrentElement::getName ( ) const

override

Returns

The name of the element: "SteppedCurrent".

getSamplingInterval()

double AisSteppedCurrentElement::getSamplingInterval

(

)

const

Returns

the data sampling interval value in seconds.

getStartCurrent()

double AisSteppedCurrentElement::getStartCurrent

(

)

const

Returns

The starting current value in amperes.

getStepDuration()

double AisSteppedCurrentElement::getStepDuration

(

)

const

Returns

The duration of each current step in seconds.

getStepSize()

double AisSteppedCurrentElement::getStepSize

(

)

const

Returns

The size of each current step in amperes.

setApproxMaxVoltage()

void AisSteppedCurrentElement::setApproxMaxVoltage

(

double

approxMaxVoltage

)

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

)

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

Parameters

approxMinVoltage

the value for the minimum current expected in V.

setEndCurrent()

void AisSteppedCurrentElement::setEndCurrent

(

double

iEnd

)

Parameters

iEnd	The ending current value in amperes.

setSamplingInterval()

void AisSteppedCurrentElement::setSamplingInterval

(

double

samplingInterval

)

Parameters

samplingInterval

the data sampling interval value in seconds.

setStartCurrent()

void AisSteppedCurrentElement::setStartCurrent

(

double

iStart

)

Parameters

iStart

The starting current value in amperes.

setStepDuration()

void AisSteppedCurrentElement::setStepDuration

(

double

tStep

)

Parameters

tStep

The duration of each current step in seconds.

setStepSize()

void AisSteppedCurrentElement::setStepSize

(

double

iStep

)

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