GenericGenerator Class Reference

Generic Voltage Generator Class. More...

#include <vgenerator.hpp>

Inheritance diagram for GenericGenerator:

Public Member Functions
	GenericGenerator (const VGenerator *owner)
	Constructor. 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	initCalibration (float reference)
	Starts the calibration process. More...
virtual void	saveCalibration (float measure)
	Finishes the calibration process. More...
virtual void	on ()=0
	Enables the output of the Voltage Generator. More...
virtual void	off ()=0
	Disables the output of the Voltage Generator. 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

Generic Voltage Generator Class.

The purpose of this class is to provide the methods to manipulate a Voltage Generator (based in a DC2DC converter and GPIO pins to control

• on/off - the output).

Constructor & Destructor Documentation

GenericGenerator()

GenericGenerator ( const VGenerator *  owner )

explicit

Constructor.

Parameters

owner

Pointer to owner VGenerator object instance.

Member Function Documentation

isRunning()

bool isRunning ( ) const

virtual

Returns if the Voltage Generator is running.

Returns

True if Voltage Generator is running, false otherwise.

setV()

void setV ( float  value )

virtual

Sets the target output voltage of the Voltage Generator.

Parameters

value

Target output voltage, in Volts.

getVTarget()

float getVTarget ( ) const

virtual

Gets the target output voltage of the Voltage Generator.

Returns

Target output voltage, in Volts.

getV()

float getV ( ) const

virtual

Gets the current output voltage of the Voltage Generator.

Returns

Current output voltage, in Volts.

getCalibration()

float getCalibration ( ) const

virtual

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

Returns

Calibration value.

getDuty()

float getDuty ( ) const

virtual

Gets the current duty cycle of the PWM.

Returns

Current duty cycle value, in percent.

initCalibration()

void initCalibration ( float  reference )

virtual

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.

Reimplemented in VddGenerator, and VppGenerator.

saveCalibration()

void saveCalibration ( float  measure )

virtual

Finishes the calibration process.

Calculates and saves the calibration value.

Parameters

measure

Measured voltage, in Volts.

on()

virtual void on ( )

pure virtual

Enables the output of the Voltage Generator.

Implemented in VppGenerator, and VddGenerator.

off()

virtual void off ( )

pure virtual

Disables the output of the Voltage Generator.

Implemented in VppGenerator, and VddGenerator.

toggle()

void toggle ( )

virtual

Toggles the output of the Voltage Generator.

isOn()

bool isOn ( ) const

virtual

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