Benutzerdokumentation
Was macht das Programm?
Das in diesem Dokument erläuterte Programm calc berechnet die Kapazität eines Zylinderkondensators für zwei verschiedene Dielektrika. Dazu werden dem Programm Wertetripel übergeben: die Länge des Kondensators (Ganzzahl), der innere Radius des Zylinders (Kommazahl) und der äußere Radius des Zylinders (Kommazahl). Fest im Programm sind die Kapazitätswerte für Paraffin und Ölpapier bereits gespeichert, welche sich aber selbstverständlich auf einfache Art und Weise durch den Benutzer ändern lassen.
Programmausführung
Anmerkung: Unter Linux, Mac OS und sonstigen Unix-Derivaten heißt das Programm calc.exe nur calc.
Wechseln in das richtige Verzeichnis
Um das Programm mit der Konsole auszuführen, wird der Pfad, in dem die Datei liegt mit dem Befehl cd in die Konsole eingegeben. Liegt die Datei beispielsweise im Ordner C:\Users\xyz\Eigene Dateien\Assembler, muss in die Konsole folgendes geschrieben werden:
cd C:\Users\xyz\Documents\Assembler
Mit dem Befehl dir (unter Unix/Linux: ls) wird der Inhalt des Ordners angezeigt.
Die Option -v
Um die Datei calc.exe auszuführen, wird calc.exe -v x (x kann die Werte 0 oder 1 oder 2 annehmen) eingegeben. Durch den Wert, der übergeben wird, wird das Ausmaß der Ausgabe festgelegt. Bei 0 wird dem Benutzer nur das Ergebnis mitgeteilt, bei 1 werden ein paar Details angezeigt und bei 2 werden auch Zwischenergebnisse angezeigt.
Sowohl bei -v 1 als auch bei -v 2 wird der Benutzer nun aufgefordert dem Programm Werte zu übergeben. Bei -v 0 wird der Benutzer nicht dazu aufgefordert, er muss dem Programm aber trotzdem Werte übergeben, damit das Programm ausgeführt werden kann.
Eingabe mit einer CSV-Datei
Die Werte mit denen gerechnet werden soll, können in einer CSV-Datei gespeichert sein (» Erstellen einer Eingabedatei (CSV-Datei)). Um diese zu übergeben, muss nur der Name der CSV-Datei eingegeben werden, also z.B. calc.exe in.csv. Werden die Werte per CSV-Datei eingegeben, wird das Programm durch Enter ausgeführt.
Werte direkt übergeben
Alternativ können die Werte dem Programm direkt über die Konsole übergeben werden. In diesem Fall wird kein Dateiname angegeben. Die Syntax bei der Eingabe ist die selbe, wie bei den CSV-Dateien. Um die Eingabe der Daten zu beenden, wird unter Linux/Mac die Tastenkombination Ctrl+D verwendet. Unter Windows gibt es keinen Befehl, der die Berechnung startet. Hier muss eine beliebige ungültige Eingabe gemacht werden
Speichern der Ergebnisse
Um die berechneten Werte in einer Datei zu speichern, wird zusätzlich zu calc.exe -v 1 in.csv noch -o Dateiname angegeben. Die berechneten Werte werden dann in der Datei mit dem angegebenen Namen gespeichert. ACHTUNG: Besteht eine Datei mit diesem Namen bereits, so wird diese ohne Nachfrage überschrieben und der vorherige Inhalt geht verloren! Die Verwendung des selben Dateinamens für Eingabe und Ausgabe funktioniert nicht! Außerdem müssen sämtliche Befehle der Form -name wert vor der Angabe der Eingabedatei gemacht werden. Ein Programmaufruf der Form calc.exe -v 1 in.csv -o out.csv ist nicht gültig!
Neue Dielektrizitätskonstanten und die Option -h
Sollen andere Dielektrika als Ölpapier und Paraffin verwendet werden, können dem Programm andere Werte für die Kapazitätswerte der Dielektrika übergeben werden. Dies geschieht mit den Befehlen -er1 und -er2. Hier müssen Kommazahlen (Floats) übergeben werden:
calc.exe in.csv –o out.csv –er1 2.5 –er2 3
Alle Befehle im Überblick erhält man durch den Befehl –h. (» Befehlsübersicht)
Befehlsübersicht
-h:
Übersicht über alle Befehle. Verwendung: calc.exe -h
-v x: x kann die Werte 0, 1 oder 2 annehmen. Damit wird vom Anwender die Ausgabe gesteuert. Bei 0 wird nur das Ergebnis angezeigt, bei 2 werden alle Details angezeigt.
-o Dateiname:
Datei, in die die Ergebnisse gespeichert werden sollen, z.B. calc.exe -o test.txt -v 2. Dabei spielt es keine Rolle, ob zuerst -o test.txt oder -v 2 geschrieben wird. Wird dieser Befehl nicht verwendet, wird das Ergebnis nicht gespeichert und nur auf der Konsole ausgegeben.
ACHTUNG: Existiert die Datei test.txt in diesem Ordner bereits, so wird diese OHNE NACHFRAGE überschrieben.
-er1 float:
mit -er1 float kann ein neuer Wert für die Dielektrizitätskonstante er1 eingegeben werden, der dann für die Berechnung verwendet wird.
-er2 float:
mit -er2 float kann ein neuer Wert für die Dielektrizitätskonstante er2 eingegeben werden, der dann für die Berechnung verwendet wird.
Erstellen einer Eingabedatei
Zur Eingabe von Zylinderlänge und Zylinderradien können CSV-Dateien verwendet werden. CSV steht für „Comma-Separated Values“. Um eine CSV-Datei mit Werten zu erstellen, mit denen das Programm die Formel berechnet, muss folgendes beachtet werden:
- Pro Zeile werden drei Zahlen benötigt, die erste ist die Länge des Zylinders (Integer), die anderen Beiden sind die Zylinderradien (innerer und äußerer, Floats), wobei der dritte Wert größer sein muss als der zweite, um ein sinnvolles Ergebnis zu erhalten. Eine falsche Eingabe (innerer Radius größer als äußerer Radius) führt aber nicht zu einem Programmabbruch. Kommazahlen werden hier in der amerikanischen Schreibweise mit Punkt als Trennzeichen angegeben. Zahlen können nicht nur in Form von Festkomma- sondern auch als Gleitkommazahlen eingegeben werden, das bedeutet, sowohl die Eingabe 0.003 als auch die Eingabe 3e-3 sind zulässig.
- Die drei Werte werden durch Leerzeichen getrennt.
- Soll die Formel gleich für mehr als einen Kondensator berechnet werden, wird pro Kondensator eine neue Zeile angelegt
- Die Datei wird mit der Endung .csv gespeichert
Ein Beispiel für eine CSV-Datei findet sich im Projektordner unter dem Namen in.csv.