Workspace-Viewer

Grundlagen

Datenaustausch

Bei der ersten Ausführung eines Matlab Programms wird eine Pipe zu Matlab geöffnet, die solange offen bleiben soll, bis entweder der Benutzer durch einen Matlab Befehl das Programm schließt, oder die Anwendung beendet wird. Es können beliebige Matlab Befehle durch die Pipe geschickt werden und der Output wird jeweils ausgelesen. Es gibt eine Matlab-Funktion, die mit einem Variablennamen aufgerufen wird und diese Variable dann als XML-Text ausgibt.

Softwareentwicklungsprozess

Ich (Osiris) möchte verstärkt XP-Techniken einsetzten:

• Incremental Design
• Unit Tests wo möglich/wichtig
  

und zwar mit TDD (Test Driven Design) und nicht im Nachhinein

Ziel

Ein an den Workspace-Viewer von Matlab angelehnter Viewer als Eclipse-Plugin.

Folgende Funktionalitäten sollen zur Verfügung gestellt werden:

• Anzeigen einer Übersicht aller im Workspace momentan vorhandenen Variablen
• Anzeigen der Details von Variablen, ändern des Inhalts?
• Export und Import von Variablen (*.mat Files)

Weitere Anforderungen:

• Flexibilität in Hinblick auf eventuelle Änderungen der XML-Files (Matlab Versionsumstellung)

Weiteres Vorgehen

1. Einlernen in Eclipse und Pluginentwicklung für Eclipse
2. Definition der Schnittstellen
3. Grobplanung (Incremental Design)
4. Entwicklung der Klassen zum Auslesen des XML-Files
5. Entwicklung der Oberfläche
   1. Zuerst einfache Darstellung eines Files
   2. Dann Einbindung mit der entgültigen Funktionalität

Offene Fragen

(Antworten der Bosse in Farbe)

• Wie sehen die Schnittstellen zum ML-Tutor aus (genaue Definition)

• Funktionsweise der Datenübertragung / des Updatens

Nur kurz einmal: Im Endeffekt wird bei der ersten Ausführung eines Matlab Programms eine Pipe zu Matlab geöffnet, die solange offen bleiben soll, bis entweder der Benutzer durch einen Matlab Befehl das Programm schließt, oder die Anwendung beendet wird. Es können beliebige Matlab Befehle durch die Pipe geschickt werden und der Output wird jeweils ausgelesen. Es gibt eine Matlab-Funktion, die mit einem Variablennamen aufgerufen wird und diese Variable dann als XML-Text ausgibt. Dh. man müsste eine Matlab-Funktion zur Verfügung stellen, die alle vorhandenen Variablen anzeigt und diese dann nacheinander als XML-Text ausgibt. Dieser Output müsste dann vom Workspace-Viewer gelesen und in einem Eclipse View dargestellt werden. Wie das mit dem Update des Views ausschaut, müsste man sich noch überlegen. Vielleicht wäre ein vom Benutzer ausgelöstes Refresh gar nicht so schlecht.

Aber: Als erster Schritt wäre es wahrscheinlich einmal einfacher zum Testen einen Eclipse-Editor zu schreiben, der auf eine bestimmte Dateiendung reagiert und das ausgewählte File einmal darstellt. Dieses dann mit der Pipe-Funktionalität zu versehen und in einen View umzubasteln, in dem mehrere Variablen angezeigt werden, wäre dann wahrscheinlich kein allzu großes Problem mehr.

So eine Aufteilung finde ich auch auf jeden Fall sinnvoll.
--Osiris 19:22, 21 Oct 2005 (CEST)

• Unit Tests erwünscht/erbeten/notwendig/üblich oder eher nicht (schwierig bei der Oberfläche)

Schwer zu sagen, üblich sind sie leider nicht, da es so lange dauert sie zu schreiben. Es gibt ca. zu einem drittel der Funktionen unittests od. unittest-ähnliche Konstrukte. In diesem Fall würde es wahrscheinlich reichen, wenn man alle Variablenarten durchspielt und dann händisch die Anzeige der Variablen überprüft.

Ich würd' sie aber nicht schlecht finden. Was den Zeitaufwand betrifft, würd ich das nicht so sagen (zitiere meine Freundin: "TDD ist nicht langwierig!!!". Natürlich ist mehr Code zu schreiben, wenn man Code und Tests zugleich entwickelt, aber dafür fällt die komplette Testphase weg und lange Fehlersuchen gibt's auch nicht. (lang kommt es einem nur vor, wenn man die Tests nachher schreibt, aber das ist ja kein TDD)
Blöd ist nur, dass sich GUIs schwer testen lassen (da gibt's aber auch was). Aber z.B. das komplette XML-File Auslesen und das Datenhandling ließen sich wunderbar überprüfen.
Die Vorteile von TDD würden bei uns voll zum Tragen kommen, insbesondere ist es sehr brauchbar, dass der Code automatisch dokumentiert und abgesichert wäre (und zukünftige Erweiterungen eventuell durch andere Programmierer sind ja nicht so unwahrscheinlich).
Außerdem werd' ich ja auch in Eclipse entwickeln, und das mach Entwickeln mit Unit Tests ja noch einfacher als es ohnehin schon ist.
Also wenn nicht unbedingt unheimlich schnell etwas Code brauchst, würd ich gerne TDD anwenden, wo es direkt möglich ist. Wenn dies jedoch nicht erwünscht wäre, dann eben nicht, ich hab mich da nicht so drauf versteift.
--Osiris 19:11, 21 Oct 2005 (CEST)

Mir fällt gerade ein, dass die genaue Update-Strategie und das Erhalten der Variablen dem Viewer ja eigentlich egal sind. Er sollte meiner Meinung nach lediglich die Funktionalitäten zur Verfügung stellen um Variablen hinzuzufügen, alles neu aufzubauen, alles zu löschen, ...
Was dargestellt werden soll, wird durch den ML-Tutor oder ein eigenes Updater-Modul bestimmt. Letzteres hätte den Vorteil, dass man über ein geschickt gemachtes Interface auch andere Module als den Workspace-Viewer damit ansprechen könnte. (Das ist jetzt aber kein Versuch das Updaten nicht machen zu müssen ;-)
--Osiris 19:34, 21 Oct 2005 (CEST)

• Soll eine DTD zur Validierung geschrieben werden?
  

Damit könnten fehlerhaft erstellte/übertragene Files "abgefangen" werden.