Diff: Latch_FET_Driver.h

Revision:

5:7d1b124490ed

Parent:

2:9059b675917e

Child:

6:073ee2fd1245

Child:

7:909d7e3822d8

--- a/Latch_FET_Driver.h	Sun Feb 07 18:22:35 2016 +0000
+++ b/Latch_FET_Driver.h	Sat Feb 20 13:22:50 2016 +0000
@@ -1,3 +1,33 @@
+/* #####################################################################
+
+ Latch_FET_Driver.h
+ ------------------
+ 
+ Written by:        Steven Kay
+ 
+ Date:              February 2016
+ 
+ Function:          This 
+    
+ #####################################################################*/
+ 
+ /*##########################################
+
+    Embedded Software, Assignment 1
+    -------------------------------
+
+Written by: Steven Kay
+
+Date:       January 2016
+
+Function:   This program constructs and outputs a
+            pulse train on a given output pin based
+            on several input configurations generated
+            by using switches
+
+##########################################*/
+
+
 #include "mbed.h"
 
 #ifndef LATCH_FET_DRIVER
@@ -7,23 +37,67 @@
 #define LOW 0
 #define HIGH 1
 
+#define STATE_DELAY 10
+
 
 class Latch_FET_Driver
 {
 
 public:
-    Latch_FET_Driver(PinName set,PinName reset);
+    /*  =============================================================
+    Latch_FET_Driver constructor 
+    
+    Inputs
+    ------
+    PinName D:      Pin to create D input to D Latch
+    PinName CLK:    Pin to create CLK input to D Latch 
+    
+    Description
+    -----------
+    
+    Once the new DigitalOut types are assigned, the D Latch at
+    the given Pins is initialised to an outputLow state, ensuring
+    that uopn setup, a known state is entered quickly.
+    
+    =============================================================  */ 
+    Latch_FET_Driver(PinName D,PinName CLK);
+    
+    /*  =============================================================
+    outputHigh public method
+    
+    Inputs
+    ------
+    No functionally passed parameters
+    The method acts upon the DigitalOut types; _D and _CLK
+    
+    Description
+    -----------
+    Procedure to assert a HIGH state onto a D Latch attached to
+    PinName D and PinName CLK
+    =============================================================  */ 
     void outputHigh();
+    
+    /*  =============================================================
+    outputLow public method
+    
+    Inputs
+    ------
+    No functionally passed parameters
+    The method acts upon the DigitalOut types; _D and _CLK
+    
+    Description
+    -----------
+    Procedure to assert a LOW state onto a D Latch attached to
+    PinName D and PinName CLK
+    =============================================================  */ 
     void outputLow();
-//    int setOutput();
-//    int resetOutput();
+    
 private:
-    void initialState();
-
     
 protected:
-    DigitalOut *SetPin;
-    DigitalOut *ResetPin;
+    // DigitalOut types used for assignment of PinName data types
+    DigitalOut *_D;
+    DigitalOut *_CLK;
 };
 
 #endif
\ No newline at end of file