Diplomarbeit JRoboSim - Entwicklerdokumentation

 

Home

Beschreibung

Projektmanagement

Entwickeln von Steuerungen

Einbinden neuer Roboter

Zusatzfunktionalität durch Plugins

Nützliche Verweise

 

Zusatzfunktionalität durch Plugins
1.

Für jedes Plugin wird im CVS - Modul JRoboSim - Components ein neues Verzeichnis angelegt. Dieses sollte die folgende Struktur aufweisen:

JRoboSim - Components Wurzelverzeichnis = Name des CVS Moduls.
+ -- plugins Enthält Plugins für JRoboSim. Für jedes Plugin wird ein neues Verzeichnis unterhalb von plugins angelegt.
     + -- mynewplugin Eindeutiger Name für das neue Plugin
          + -- build Dateien die beim Kompilieren des Plugins erzeugt werden. Nicht mit ins CVS übertragen!
          + -- dist Enthält die jeweils letzte stabile Version des Plugins gepackt als *.jar Archiv. (siehe Punkt 3)
          + -- src Quellcode des Plugins.
          + -- build.xml

ANT buildfile zum Übersetzen des Plugins und zum Erzeugen der Distribution.
Tipp: Kopiere das buildfile eines vorhandenen Plugins und passe nur Projektnamen und Pfadangaben an.

2.

Erstellen einer neuen Klasse, die entweder von de.htwdd.robotic.simulation.plugin.AbstractPlugin abgeleitet wird, oder das Interface de.htwdd.robotic.simulation.plugin.IPlugin implementiert. Überschreiben der benötigten Methoden.

Weitere Informationen zum Interface IPlugin und der Basisklasse AbstractPlugin können der javadoc des Projekts entnommen werden.

3.

Packen aller Klassen des Plugins und aller benötigter Ressourcen (Bilder, Textdateien usw.) in ein JAR-File. In das JAR-File muss außerdem der "Service", der von diesem Jar bereitgestellt wird definiert werden:

in das Jar-File wird ein Verzeichnis META-INF/services eingefügt. In diesem Verzeichnis wird eine Textdatei angelegt, die den Namen des implementierten Interfaces erhält (de.htwdd.robotic.simulation.world.robot.IPlugin). In diese Datei werden alle Klassen dieser Jar-Datei eingetragen, die dieses Interface implementieren. Daraus folgt, dass auch mehrere Plugins in ein Jar-Archiv gepackt werden können, es müssen nur alle Implementierungen in die dazugehörige Textdatei eingetragen werden.

Das Kompilieren und Erzeugen der jar-Datei kann auch automatisch durch Ausführen des ant - buildfiles vorgenommen werden.

4.

Das fertige Plugin wird veröffentlicht, indem das Jar-Archiv aus JRoboSim - Components/mynewtestplugin/dist nach JRoboSim - Components/dist/plugins kopiert wird. Dies kann auch automatisch durch Aufruf von JRoboSim - Components/build.xml erfolgen.

 
 
Erstellt von Katja Hofmann, FB Informatik der HTW Dresden, 24.04.03 bis 24.07.03