AisDataManipulator Class Reference

The AisDataManipulator class offers advanced control over pulse data collection and manipulation. It provides methods to manipulate AIS primary data for all three pulse voltammetry experiments types, namely Differential Pulse Voltammetry (DPV), Square Wave Voltammetry (SWV), and Normal Pulse Voltammetry (NPV). More...

#include <AisDataManipulator.h>

Public Member Functions
	AisDataManipulator ()
	Default constructor for AisDataManipulator class.
AisErrorCode	setPulseType (AisPulseType type, double pulseWidth, double pulsePeriod)
	Set pulse type with pulse width and pulse period. More...
AisErrorCode	setPulseType (AisPulseType type, double frequency)
	Set pulse type with frequency. More...
double	getPulseWidth () const
	Get the pulse width. More...
double	getPulsePeriod () const
	Get the pulse period. More...
double	getFrequency () const
	Get the pulse frequency. More...
bool	isPulseCompleted () const
	Check if the pulse is completed. More...
double	getBaseCurrent () const
	Get the base current. More...
double	getPulseCurrent () const
	Get the pulse current. More...
double	getBaseVoltage () const
	Get the base voltage. More...
double	getPulseVoltage () const
	Get the pulse voltage. More...
void	loadPrimaryData (const AisDCData &data)
	Load primary data from AisDCData object. More...

Detailed Description

The AisDataManipulator class offers advanced control over pulse data collection and manipulation. It provides methods to manipulate AIS primary data for all three pulse voltammetry experiments types, namely Differential Pulse Voltammetry (DPV), Square Wave Voltammetry (SWV), and Normal Pulse Voltammetry (NPV).

The Pulse Voltammetry example shows how to use this class with each pulse element.

Member Function Documentation

getBaseCurrent()

double AisDataManipulator::getBaseCurrent

(

)

const

Get the base current.

Returns

The base current.

getBaseVoltage()

double AisDataManipulator::getBaseVoltage

(

)

const

Get the base voltage.

Returns

The base voltage.

getFrequency()

double AisDataManipulator::getFrequency

(

)

const

Get the pulse frequency.

Returns

The pulse frequency.

getPulseCurrent()

double AisDataManipulator::getPulseCurrent

(

)

const

Get the pulse current.

Returns

The pulse current.

getPulsePeriod()

double AisDataManipulator::getPulsePeriod

(

)

const

Get the pulse period.

Returns

The pulse period.

getPulseVoltage()

double AisDataManipulator::getPulseVoltage

(

)

const

Get the pulse voltage.

Returns

The pulse voltage.

getPulseWidth()

double AisDataManipulator::getPulseWidth

(

)

const

Get the pulse width.

Returns

The pulse width.

isPulseCompleted()

bool AisDataManipulator::isPulseCompleted

(

)

const

Check if the pulse is completed.

Returns

True if the pulse is completed, false otherwise.

loadPrimaryData()

void AisDataManipulator::loadPrimaryData

(

const AisDCData &

data

)

Load primary data from AisDCData object.

Parameters

data	The AisDCData object containing primary data.

setPulseType() [1/2]

AisErrorCode AisDataManipulator::setPulseType	(	AisPulseType	type,
		double	frequency
	)

Set pulse type with frequency.

Note

This function is usefull only for SquarewavePulse.

Parameters

type	The type of pulse.
frequency	The frequency of the pulse.

Returns

AisErrorCode::Success if pulse setting was successful. If not successful, possible returned errors are:

• AisErrorCode::FailedRequest

setPulseType() [2/2]

AisErrorCode AisDataManipulator::setPulseType	(	AisPulseType	type,
		double	pulseWidth,
		double	pulsePeriod
	)

Set pulse type with pulse width and pulse period.

Note

This function is usefull only for DifferentialPulse and NormalPulse.

Parameters

type	The type of pulse.
pulseWidth	The width of the pulse.
pulsePeriod	The period of the pulse.

Returns

AisErrorCode::Success if pulse setting was successful. If not successful, possible returned errors are:

• AisErrorCode::FailedRequest

---

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

• AisDataManipulator.h