Browse Source

README: update Konstruktor & Destruktor

Tobias Müller 5 years ago
parent
commit
03531c7dd6
2 changed files with 78 additions and 13 deletions
  1. 78 13
      README.md
  2. BIN
      README.pdf

+ 78 - 13
README.md

@@ -129,20 +129,20 @@ Symbole der Klasse **`HSA_LCD_Shield`** werden hauptsächlich zur besseren Lesba
 
 * **Standard LC-Display I²C-Adresse**
 
-    ```c
+    ```arduino
     I2C_ADDRESS        0x3C
     ```
 
 * **LCD-Shield Versionen**
 
-    ```c
+    ```arduino
     LCD_VERSION_5        0x05
     LCD_VERSION_6        0x06
     ```
 
 * **LCD-Shield Konfigurationen**
 
-    ```c
+    ```arduino
     CONFIG_L1B1        "L1B1"        // Config: LEDs = On, Buttons = On
     CONFIG_L0B1        "L0B1"        // Config: LEDs = Off, Buttons = On
     CONFIG_L1B0        "L1B0"        // Config: LEDs = On, Buttons = Off
@@ -151,7 +151,7 @@ Symbole der Klasse **`HSA_LCD_Shield`** werden hauptsächlich zur besseren Lesba
 
 * **Taster**
 
-    ```c
+    ```arduino
     BUTTON_UP        0x01
     BUTTON_RIGHT     0x02
     BUTTON_DOWN      0x03
@@ -160,7 +160,7 @@ Symbole der Klasse **`HSA_LCD_Shield`** werden hauptsächlich zur besseren Lesba
 
 * **LEDs**
 
-    ```c
+    ```arduino
     LED_RED        0x05
     LED_GREEN      0x06
     ```
@@ -175,21 +175,86 @@ Damit Methoden einer Klasse verwendet werden können, muss zunächst ein Objekt
 
     <u>Definition:</u>
 
-    Standard:
-    ```arduino
-    HSA_LCD_Shield <object>(byte version, const char config[5]);
-    ```
+    * Standard:
+        ```arduino
+        HSA_LCD_Shield <objekt>(byte <version>, const char <config>[5]);
+        ```
+
+    * Vererbung:
+        ```arduino
+        HSA_LCD_Shield <Objekt> = HSA_LCD_Shield(byte <version>, const char <config>[5]);
+        ```
+
+    <u>Beschreibung:</u>
+
+    Erstellt ein `<Objekt>` der Klasse **`HSA_LCD_Shield`**.
+
+    <u>Parameter:</u>
+
+    * `<version>` *(optional):* Angabe der LCD-Shield Versionsnummer mit `LCD_VERSION_5` oder `LCD_VERSION_6`. Wird kein Parameter übergeben, wird automatisch die höchste Versionsnummer ausgewählt (Standard).
+
+    * `<config>` *(optional):* Angabe der LED- und Tasterkonfigurationen mit `CONFIG_L1B1`, `CONFIG_L0B1`, `CONFIG_L1B0` und `CONFIG_L0B0`. Hinweise zu den Konfigurationsmöglichkeiten finden Sie unter [Symbole](#Attribute). Entsprechend der Konfigutaion werden GPIOs initialisiert. Wird kein Parameter übergeben, werden automatich die Taster und LEDs initialisiert (Standard). 
+
+    <u>Beispiel:</u>
+
+    * Beispiel 1:
+        ```arduino
+        // Erstelle Objekt der Klasse mit Standardeinstellungen.
+        HSA_LCD_Shield Display();
+        ```
+
+    * Beispiel 2:
+        ```arduino
+        // Erstelle Objekt der Klasse für LCD-Shield Version 5 und Standardeinstellungen
+        // für LEDs und Taster.
+        HSA_LCD_Shield Display(LCD_VERSION_5);
+        ```
+
+    * Beispiel 3:
+        ```arduino
+        // Erstelle Objekt der Klasse ohne Initialisierung der Taster und LEDs
+        // und mit Standardeinstellungen für die LCD-Shield Version.
+        HSA_LCD_Shield Display(CONFIG_L0B0);
+        ```
+
+    * Beispiel 4:
+        ```arduino
+        // Erstelle Objekt der Klasse für LCD-Shield Version 5, ohne Initialisierung der
+        // LEDs aber mit Initialisierung der Taster.
+        HSA_LCD_Shield Display(LCD_VERSION_5, CONFIG_L0B1);
+        ```
+
+    * Beispiel 5:
+        ```arduino
+        // Erstelle Objekt der Klasse durch Vererbung mit Standardeinstellungen.
+        HSA_LCD_Shield Display = HSA_LCD_Shield();
+        ```
+    
+
+* **Destruktor:**
+
+    <u>Definition:</u>
 
-    Vererbung:
     ```arduino
-    HSA_LCD_Shield <object> = HSA_LCD_Shield(byte version, const char config[5]);
+    ~<Objekt>(void);
     ```
 
     <u>Beschreibung:</u>
 
-    Erstellung eines Objektes der Klasse **`HSA_LCD_Shield`**
+    Entfernt ein `<Objekt>` der Klasse **`HSA_LCD_Shield`**.
 
-    
+    <u>Beispiel:</u>
+
+    ```arduino
+    // Erstelle Objekt der Klasse mit Standardeinstellungen.
+    HSA_LCD_Shield Display();
+
+    // Führe andere Anweisungen aus!!
+    // ...
+
+    // Entferne Objekt der Klasse wieder.
+    ~Display();
+    ```
 
 
 <div id='Methoden'/>

BIN
README.pdf