additions to the documentation

doku/content.tex

@@ -415,24 +415,56 @@ Sobald die gesuchten Daten in der «TextBox» eingegeben wurden, werden
 die Informationen aufgerufen und in der «ListBox» aufgezeigt.
 
 
-\subsubsection{Datenverarbeitung}
+\subsubsection{Definition der Klassen}
 
-Um die benötigten Daten von der Datenbank hinzuzufügen oder
-zurückzuschicken, brauchen wir ein Model, in welches Daten eingefügt
-werden können. Hierfür erstellten wir eine neue Klasse, die wir
-«cities» nennen und die Struktur dieser Tabelle aus der Datenbank
-abbilden. In der Klasse « dataaccess» bauen wir eine Methode auf, mit
-der wir die Daten als Liste mit einer neuen Verbindung abrufen(und
-danach wieder schliessen) können und haben die «ListBox» in der
-«Dashboard» Klasse damit verbunden. Um die Verbindung zur « listBox»
-zu vervollständigen, haben wir in der «cities» Klasse die Lese-
-Eigenschaft «Fullinfo» eingesetzt, um nur die gewollten Daten
-abzurufen.
+Hier werden alle eingesetzten Klassen der Applikation vorgestellt
+und definiert.
 
-Mit einem connection.Query Funktion, haben wir wie in einer SQL-
-Datenbank Funktionk, danach die Daten in der Klasse «dataaccess»
-abgefragt.
+\textbf{Programm}
+\newline
+Dient grundsätzlich als Eintrittspunkt der Applikation und hat sonst keine grosse Funktion.
 
+\textbf{Helper}
+\newline
+Helper.cs dient dem Zweck, den Pfad der Datenbank nicht in jeder
+Methode eingeben zu müssen.
+Daführ haben wir in dieser Klasse den Verbindungsaufbau durch den Configuration.Manager definiert.
+Den Pfad zur Datenbank muss dadurch nur ein einziges Mal in App.config definiert werden und kann dann durch die Helper.cs Klasse simpel aufgerufen werden.
+
+
+\textbf{LoginForm}
+\newline
+Diese Klasse wurde für das Registrieren und Einloggen des Benutzers
+mit einem dazugehörigen GUI von uns erstellt.
+Dadurch können sich Benutzer durch das Eingeben der Email-Adresse und des Passwortes mit dem "Register-Button" Registrieren und durch ein zweites eingeben der Daten und betätigen des "Login-Button" auch gleich einloggen.
+Nach dem Login wird auch gleich eine Nachricht der Applikation dem Benutzer mit dem Text "It worked" aufgezeigt, um den erfolgreichen Login zu melden.
+Dadurch möchten wir die Funktion des einfüllen und Lesen der Daten aus der Datenbank aufzeigen.
+Den Verbindungsaufbau in die Datenbank mit allen nötigen Funktion(Schreiben / Lesen) haben wir in die Klasse "DataAccess" ausgelagert.
+
+\textbf{Dashboard}
+\newline
+Auf dem Dashboard haben wir unseren Kern was Informationen herauslesen und wieder Eingeben belangt, erstellt.
+In dieser Klasse werden die aus der Datenbank herausgelesenen Daten der locations / (Standorte) und rents / (Mieten) Tabellen im GUI aufgezeigt und /oder eingefügt.
+Damit möchten wir einen Teil unserer Applikation und Datenbank abbilden, mit der Benutzer Standort heraussuchen können, neue Standorte hinzugefügt werden können und den Mietbeginn/ das Zahlungsdatum eingegeben werden kann.
+Den Verbindungsaufbau in die Datenbank mit allen nötigen
+Funktion(Schreiben / Lesen) haben wir in die Klasse "DataAccess" ausgelagert und vom GUI aus verankert.
+
+\textbf{DataAccess}
+\newline
+Mit der DataAccess Klasse konnten wir nahezu alle Datenbank relevanten Funktionen, die sonst in unseren GUI ausgeführt werden, in einer einzigen Klasse abbilden.
+Darin haben wir den Aufruf der Datenbanktabellen mit den dazu benötigten SQl - Befehlen ausgeführt.
+Dadurch wird SQl- Code nur in dieser Klasse aufgerufen und verwendet.
+
+\textbf{GetRents}
+\newline
+
+
+\textbf{GetMembers}
+\newline
+
+
+\textbf{GetLocations}
+\newline
 
 
 \subsubsection{Problematik}
@@ -442,7 +474,7 @@ abgefragt.
 
 -Datenvormatierung (Geburtstag)
 
-\subsubsection{Referenzen und Addons}
+\subsubsection{Referenzen und Addons/ Packages}
 Mit Dapper \cite{dbcs6} entschieden wir uns, nachdem wir ein wenig
 nachgeforscht haben und wir auf Stack Overflow fündig wurden. Da auf
 dieser Webseite Dapper genutzt wird und wir bisher immer gute