Reiko Randoja / CoilGun
Embed: (wiki syntax)

« Back to documentation index

Coilgun Class Reference

Coilgun Class Reference

Class for controlling coilgun. More...

#include <coilgun.h>

Public Member Functions

 Coilgun (PinName kickPinName, PinName chargePinName, PinName donePinName)
 Create an instance of the Coilgun connected to specfied pins.
void kick (unsigned int length)
 Kick with coilgun.
void kickEnd (void)
 Stop kick.
void charge (void)
 Charge capacitor.
void chargeEnd (void)
 Stop charging capacitor.
void discharge (void)
 Discharge capacitor.
void dischargeEnd (void)
 Stop discharging.

Data Fields

bool isCharged
 Read only Will be set to true, when charge() is called, false, when discharge is called.

Detailed Description

Class for controlling coilgun.

Definition at line 7 of file coilgun.h.


Constructor & Destructor Documentation

Coilgun ( PinName  kickPinName,
PinName  chargePinName,
PinName  donePinName 
)

Create an instance of the Coilgun connected to specfied pins.

Definition at line 3 of file coilgun.cpp.


Member Function Documentation

void charge ( void   )

Charge capacitor.

Definition at line 40 of file coilgun.cpp.

void chargeEnd ( void   )

Stop charging capacitor.

Definition at line 47 of file coilgun.cpp.

void discharge ( void   )

Discharge capacitor.

Definition at line 52 of file coilgun.cpp.

void dischargeEnd ( void   )

Stop discharging.

Definition at line 59 of file coilgun.cpp.

void kick ( unsigned int  length )

Kick with coilgun.

Definition at line 15 of file coilgun.cpp.

void kickEnd ( void   )

Stop kick.

Definition at line 29 of file coilgun.cpp.


Field Documentation

bool isCharged

Read only Will be set to true, when charge() is called, false, when discharge is called.

NB! if discharge is interrupted, capacitor may still have some charge on it.

Definition at line 32 of file coilgun.h.