VppGenerator Class Reference

Voltage (VPP) Generator Class. More...

#include <vgenerator.hpp>

Inheritance diagram for VppGenerator:

Public Member Functions
	VppGenerator (const VGenerator *owner)
	Constructor. More...
void	on ()
	Enables the output of the Voltage Generator. More...
void	off ()
	Disables the output of the Voltage Generator. More...
void	initCalibration (float reference=12.0f) override
	Starts the calibration process. More...
void	onA9 (bool status=true)
	Sets/Resets the VPP on A9 pin. More...
void	onA18 (bool status=true)
	Sets/Resets the VPP on A18 pin. More...
void	onCE (bool status=true)
	Sets/Resets the VPP on CE pin. More...
void	onOE (bool status=true)
	Sets/Resets the VPP on OE pin. More...
void	onWE (bool status=true)
	Sets/Resets the VPP on WE pin. More...
bool	isOnA9 () const
	Gets the VPP on A9 pin status. More...
bool	isOnA18 () const
	Gets the VPP on A18 pin status. More...
bool	isOnCE () const
	Gets the VPP on CE pin status. More...
bool	isOnOE () const
	Gets the VPP on OE pin status. More...
bool	isOnWE () const
	Gets the VPP on WE pin status. More...
virtual bool	isRunning () const
	Returns if the Voltage Generator is running. More...
virtual void	setV (float value)
	Sets the target output voltage of the Voltage Generator. More...
virtual float	getVTarget () const
	Gets the target output voltage of the Voltage Generator. More...
virtual float	getV () const
	Gets the current output voltage of the Voltage Generator. More...
virtual float	getCalibration () const
	Returns the calibration value of the output of the Voltage Generator. More...
virtual float	getDuty () const
	Gets the current duty cycle of the PWM. More...
virtual void	saveCalibration (float measure)
	Finishes the calibration process. More...
virtual void	toggle ()
	Toggles the output of the Voltage Generator. More...
virtual bool	isOn () const
	Returns if output of the Voltage Generator is enabled. More...

Friends
class	VGenerator

Detailed Description

Voltage (VPP) Generator Class.

The purpose of this class is to provide the methods to manipulate a Voltage (VPP) Generator (based in a boost DC2DC converter, GPIO pins and one shift register to control - on/off - the output).

Constructor & Destructor Documentation

VppGenerator()

VppGenerator ( const VGenerator *  owner )

explicit

Constructor.

Parameters

owner

Pointer to owner VGenerator object instance.

Member Function Documentation

on()

void on ( )

virtual

Enables the output of the Voltage Generator.

Implements GenericGenerator.

off()

void off ( )

virtual

Disables the output of the Voltage Generator.

Implements GenericGenerator.

initCalibration()

void initCalibration ( float  reference = 12.0f )

overridevirtual

Starts the calibration process.

Sets the calibration value to zero, and sets the output voltage to value of the reference parameter.

Parameters

reference

Calibration target voltage, in Volts. Default: 12.0.

Reimplemented from GenericGenerator.

onA9()

void onA9

(

bool

status = true

)

Sets/Resets the VPP on A9 pin.

Parameters

status

True to set pin, false to reset.

onA18()

void onA18

(

bool

status = true

)

Sets/Resets the VPP on A18 pin.

Parameters

status

True to set pin, false to reset.

onCE()

void onCE

(

bool

status = true

)

Sets/Resets the VPP on CE pin.

Parameters

status

True to set pin, false to reset.

onOE()

void onOE

(

bool

status = true

)

Sets/Resets the VPP on OE pin.

Parameters

status

True to set pin, false to reset.

onWE()

void onWE

(

bool

status = true

)

Sets/Resets the VPP on WE pin.

Parameters

status

True to set pin, false to reset.

isOnA9()

bool isOnA9

(

)

const

Gets the VPP on A9 pin status.

Returns

The pin status.

isOnA18()

bool isOnA18

(

)

const

Gets the VPP on A18 pin status.

Returns

The pin status.

isOnCE()

bool isOnCE

(

)

const

Gets the VPP on CE pin status.

Returns

The pin status.

isOnOE()

bool isOnOE

(

)

const

Gets the VPP on OE pin status.

Returns

The pin status.

isOnWE()

bool isOnWE

(

)

const

Gets the VPP on WE pin status.

Returns

The pin status.

isRunning()

bool isRunning ( ) const

virtualinherited

Returns if the Voltage Generator is running.

Returns

True if Voltage Generator is running, false otherwise.

setV()

void setV ( float  value )

virtualinherited

Sets the target output voltage of the Voltage Generator.

Parameters

value

Target output voltage, in Volts.

getVTarget()

float getVTarget ( ) const

virtualinherited

Gets the target output voltage of the Voltage Generator.

Returns

Target output voltage, in Volts.

getV()

float getV ( ) const

virtualinherited

Gets the current output voltage of the Voltage Generator.

Returns

Current output voltage, in Volts.

getCalibration()

float getCalibration ( ) const

virtualinherited

Returns the calibration value of the output of the Voltage Generator.

Returns

Calibration value.

getDuty()

float getDuty ( ) const

virtualinherited

Gets the current duty cycle of the PWM.

Returns

Current duty cycle value, in percent.

saveCalibration()

void saveCalibration ( float  measure )

virtualinherited

Finishes the calibration process.

Calculates and saves the calibration value.

Parameters

measure

Measured voltage, in Volts.

toggle()

void toggle ( )

virtualinherited

Toggles the output of the Voltage Generator.

isOn()

bool isOn ( ) const

virtualinherited

Returns if output of the Voltage Generator is enabled.

Returns

True if output of the Voltage Generator is enabled, false otherwise.

---

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

• vgenerator.hpp
• vgenerator.cpp