Diplomarbeit JRoboSim - Entwicklerdokumentation

Dieses Dokument gibt einen Überblick über die Struktur des Projektes JRoboSim. Es beschreibt die Arbeit mit dem dafür eingerichteten CVS - System und den ANT - Skripten, die für die Entwicklung neuer Komponenten genutzt werden.

Für die Arbeit am Projekt JRoboSim muss ein Login für den Server iwaps1 des Roboterseminars an der HTW Dresden vorliegen. Dieses richtet auf Anfrage der derzeitige Administrator dieses Projektseminars ein.

Für JRoboSim existieren unabhängige CVS - Projektmodule. Das Modul RoboSim enthält die vollständigen Quellen und Projektdateien für die Entwicklung des JRoboSim Frameworks.

RoboSim	Wurzelverzeichnis = Name des CVS Moduls
+ -- bak	Wird nur lokal für backup Dateien verwendet. Inhalt nicht ins CVS hochladen!
+ -- build	Wird nur lokal für kompilierte Dateien verwendet. Inhalt nicht ins CVS hochladen!
+ -- dist	Enthält die jeweils letzte stabile Version von JRoboSim in auslieferbarer Form (*.jar). Nur das dafür verantwortliche Projektmitglied stellt diese Dateien ins CVS.
+ -- doc	Javadoc generierte Dateien und andere Dokumentation wie Diagramme und eigene Textdokumente.
+ -- lib	Alle zum kompilieren und ausführen des Projektes erforderlichen Bibliotheken.
+ -- src	Alle Quelldateien des Projektes.
+ -- testfiles	Dateien zum Test des Projektes.
+ -- xml	XML, XML - Schema und Skripte zum Generieren der Java - Quellen aus XML - Schemas.

Für die entwicklung von Zusatzkomponenten für JRoboSim wird das CVS - Modul RoboSim-Components verwendet. Es enthält die Quelltexte für Steuerungen, Roboter und Plugins, sowie jeweils eine lauffähige Version der jeweiligen Komponente. Zum kompilieren der Projekte und zum Erzeugen der benötigten *.jar Archive können die im Modul bereitgestellten ANT - Skripte genutzt werden.

JRoboSim - Components	Wurzelverzeichnis = Name des CVS Moduls.
+ -- controls	Enthält die Steuerungen für Roboter in JRoboSim. Für jede Steuerung wird ein neues Verzeichnis unterhalb von controls angelegt.
+ -- testcontrol	Beispielsteuerung.
+ -- dist	Enthält die jeweils letzte stabile Version aller Steuerungen, Roboter und Plugins, sowie der letzten stabilen Version von JRoboSim.
+ -- lib	Alle zum Kompilieren und Ausführen der Komponenten erforderlichen Bibliotheken.
+ -- plugins	Enthält Plugins für JRoboSim. Für jedes Plugin wird ein neues Verzeichnis unterhalb von plugins angelegt.
+ -- testplugin	Beispielplugin.
+ -- robots	Enthält Roboterimplementierungen für JRoboSim. Für jeden Roboter wird ein neues Verzeichnis unterhalb von robots angelegt.
+ -- testrobot	Beispielroboter.

 

Das Projekt JRoboSim kann aus dem zentralen CVS - Repository vom Server der HTW Dresden geladen werden. Die Nutzung des CVS - Systems erfolgt über die Konsole (nachdem ein cvs - Client installiert wurde) oder über ein grafisches Tool wie z.B. WinCVS. Die Schritte zum Anmelden am CVS - Server und Auschecken der Projektdateien wird am Beispiel von WinCVS erläutert.

1.	Der Nutzer erstellt ein neues Verzeichnis in das die Projektdateien eingelesen werden sollen, z.B. D:\cvs_projects\sxxxx\. (sxxxx = Loginname des Nutzers)
2.	Beim ersten Start von WinCVS wird der CVSROOT abgefragt. Dieser kann auch im Menü Admin -> Preferences... eingegeben werden. Folgende Angaben sind erforderlich: Art der Authentifizierung ext (external = "password file on the cvs server") Nutzername sxxxx CVS - Server iwaps1.informatik.htw-dresden.de (von HTW Rechnern auch nur iwaps1) Pfad zum CVSROOT Verzeichnis auf dem Server /home/cvsroot Zusätzlich muss die Art der Authentifizierung auf "passwd" file on the cvs server gesetzt werden. Im gleichen Dialog werden unter Globals allgemeine Einstellungen gesetzt: Checkout read-only Wenn dieses Feld eingeschaltet ist, werden die vom Server geladenen Dateien schreibgeschützt. Muss ausgeschaltet werden, wenn die Dateien geändert werden sollen. Prune (remove) empty directories Löscht automatisch leere Verzeichnisse.
3.	Unter Admin -> Login loggt sicher der Nutzer auf dem CVS Server ein. Das Passwort entspricht dem Passwort auf der iwaps1. Wenn das Einloggen erfolgreich war erscheint auf der Konsole von WinCVS die Ausschrift CVS exited normally with code 0.
4.	Mit dem Befehl Create -> Checkout Module... wird das Projektverzeichnis vom Server geladen. Zunächst erscheint der Einstellungsdialog. Hier wird der Name des Moduls angegeben, das heruntergeladen werden soll (RoboSim für Frameworkentwickler, JRoboSim - Plugins für die Entwicklung von Steuerungen, Robotern und Plugins). Local Folder to checkout to bezeichnet das Zielverzeichnis, in das die heruntergeladenen Dateien gespeichert werden. Nach dem Bestätigen dieser Einstellungen prüft WinCVS die Dateien auf dem CVS - Server und lädt sie auf den Client - Rechner. Nach erfolgreichem Herunterladen aller Dateien erscheint wieder die Aussschrift CVS exited normally with code 0.

Weiterführende Informationen zum Arbeiten mit cvs bzw. WinCVS befinden sich in den unter Nützliche Links aufgeführten Verweisen.

Um die Entwicklung von Komponenten (Steuerungen, Roboter, Plugins) für JRoboSim zu vereinfachen, werden im Modul JRoboSim - Components ant - buildfiles bereitgestellt. Diese können zum automatischen Kompilieren der Komponenten und zum Erzeugen der Distributionsversionen verwendet werden.

Zusätzlich zu den buildfiles in den Verzeichnissen der einzelnen Komponenten gibt es ein buildfile im Wurzelverzeichnis JRoboSim - Components. Damit werden alle Distributionen der Komponenten nach JRoboSim - Components/dist/ kopiert, also eine fertige Version von JRoboSim inklusive aller vorhandener Steuerungen, Roboter und Plugins erzeugt.