USB EPROM/Flash Programmer
Public Member Functions | Public Attributes | Friends | List of all members
VGenerator Class Reference

Voltage (VPP/VDD) Generator Class. More...

#include <vgenerator.hpp>

Public Member Functions

 VGenerator ()
 Constructor. More...
 
 VGenerator (const VGenConfig &config)
 Constructor. More...
 
 ~VGenerator ()
 Destructor. More...
 
void configure (const VGenConfig &config)
 Configures the Voltage Generator. More...
 
VGenConfig getConfig () const
 Gets the current configuration data. More...
 
bool start ()
 Starts the Voltage Generator. More...
 
void stop ()
 Stops the Voltage Generator. More...
 
bool isRunning () const
 Returns if the Voltage Generator is running. More...
 

Public Attributes

VppGenerator vpp
 VPP Generator. More...
 
VddGenerator vdd
 VDD Generator. More...
 

Friends

class GenericGenerator
 
class VddGenerator
 
class VppGenerator
 

Detailed Description

Voltage (VPP/VDD) Generator Class.

The purpose of this class is to provide the methods to manipulate a Voltage Generator (VPP/VDD) Module.

Constructor & Destructor Documentation

◆ VGenerator() [1/2]

Constructor.

Assumes a default value for the configuration.

◆ VGenerator() [2/2]

VGenerator ( const VGenConfig config)
explicit

Constructor.

Parameters
configConfiguration data.

◆ ~VGenerator()

~VGenerator ( )

Destructor.

Member Function Documentation

◆ configure()

void configure ( const VGenConfig config)

Configures the Voltage Generator.

If the Voltage Generator is running, then it's stopped before.

Parameters
configConfiguration data.

◆ getConfig()

VGenConfig getConfig ( ) const

Gets the current configuration data.

Returns
Copy of the current configuration data.

◆ start()

bool start ( )

Starts the Voltage Generator.

If the configuration is invalid, then fails.

Returns
True if success, false otherwise.

◆ stop()

void stop ( )

Stops the Voltage Generator.

◆ isRunning()

bool isRunning ( ) const

Returns if the Voltage Generator is running.

Returns
True if Voltage Generator is running, false otherwise.

Member Data Documentation

◆ vpp

VPP Generator.

◆ vdd

VDD Generator.


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