[Wsplgen-commits] r20 - trunk/doc/Feinkonzept
scm-commit at wald.intevation.org
scm-commit at wald.intevation.org
Tue Dec 27 22:11:32 CET 2005
Author: mrchip
Date: 2005-12-27 22:11:31 +0100 (Tue, 27 Dec 2005)
New Revision: 20
Modified:
trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex
Log:
Es wurde ein Anhang mit den Parametern und Fehlermeldungen angefangen.
Modified: trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex
===================================================================
--- trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex 2005-12-20 21:32:15 UTC (rev 19)
+++ trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex 2005-12-27 21:11:31 UTC (rev 20)
@@ -269,13 +269,14 @@
Als erstes werden von WSPLGEN die Kommandozeilenparameter ausgewertet.
Sollte das Programm hierbei unbekannte Optionen oder ungültige
Argumente zu den Optionen finden, so wird ein Fehler generiert
-(siehe Abschnitt~\ref{subsubsec:file-prot}). Werden Optionen mehrfach verwendet
-(z.B. bei der Angabe einer Option in der Kommandozeile und gleichzeitiger
-Verwendung der gleichen Option in der Parameterdatei (siehe Abschnitt \ref{subsubsec:param-par}), so wird
+(siehe Abschnitt~\ref{subsubsec:file-prot} und Abschnitt~\ref{sec:fehlermeldungen}).
+Werden Optionen mehrfach verwendet (z.B. bei der Angabe einer Option in der
+Kommandozeile und gleichzeitiger Verwendung der gleichen Option in der
+Parameterdatei (siehe Abschnitt \ref{subsubsec:param-par}), so wird
nur das erste Auftreten in der Kommandozeile berücksichtigt und eine Warnung
-generiert (siehe Abschnitt~\ref{subsubsec:file-prot}). Die zulässigen
-Kommandozeilenoptionen und ihre Argumente findet man in
-Abschnitt~\ref{subsec:param}.
+generiert (siehe Abschnitt~\ref{subsubsec:file-prot} und Abschnitt~\ref{sec:fehlermeldungen}).
+Die zulässigen Kommandozeilenoptionen und ihre Argumente findet man in
+Abschnitt~\ref{subsec:param} und Abschnitt~\ref{sec:parameter}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -446,7 +447,15 @@
\subsection{Kommandozeilen Parameter}\label{subsec:param}
-Optional können noch die folgenden Parameter zur Feinsteuerung der
+Jeder Parameter beginnt mit einem Leerzeichen gefolgt von dem Zeichen \verb;-; und
+seinem Namen. Falls dem Parameter Argumente folgen sollen, so muss als nächstes Zeichen
+ein \verb;=; folgen. Danach kommt die durch Komma getrennte Liste der Argumente. Da das
+Komma hier als Trennzeichen dient, darf es nicht ungeschützt in den Argumenten verwendet
+werden. Der Schutz des Zeichens wird durch das Einschliessen eines Arguments durch das
+Zeichen \verb;"; erreicht. Auch die Verwendung von Leerzeichen in Argumenten (z.B. Pfadangaben)
+ist so möglich.
+
+Optional können die folgenden Parameter zur Feinsteuerung der
Arbeitsweise von WSPLGEN übergeben werden:
@@ -472,7 +481,9 @@
Beispiel: \verb;-PAR=C:\TEMP\WSPLGEN.PAR;
+Standardwert: Keinen
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -DELTA (Abstufungen der Wassertiefen)}\label{subsubsec:param-delta}
@@ -529,7 +540,9 @@
In diesem Beispiel werden alle Argumente automatisch bestimmt.
+Standardwert: Siehe oben
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -GEL (Einfluss von Geländeerhebungen)}\label{subsubsec:param-gel}
@@ -549,6 +562,7 @@
Beispiel: \verb;-GEL=NOSPERRE;
+Standardwert: \verb;SPERRE;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -579,7 +593,9 @@
Beispiel: \verb;-DGM=C:\DATEN\WESER\DGM.XYZ;
+Standardwert: Keinen
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -PRO (Lage der Querprofile)}\label{subsubsec:param-profile}
@@ -603,6 +619,7 @@
Beispiel: \verb;-PRO=C:\DATEN\WESER\120-129.SHP;
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -WSP (Wasserstände)}\label{subsubsec:param-wsp}
@@ -623,7 +640,9 @@
Parameter Beispiel: \verb;-WSP=C:\DATEN\WESER\HQ5-120-129.TXT;
+Standardwert: Keinen
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -LIN (Sperren und Brüche)}\label{param-lin}
@@ -635,7 +654,9 @@
Beispiel: \verb;-LIN=C:\TEMP\BREAK.SHP;
+Standardwert: Keinen
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -AUSGABE (Ausgabedatei)}\label{subsubsec:param-ausgabe}
@@ -665,7 +686,9 @@
Beispiel: \verb;-FORT=C:\TEMP\WSPLGEN.STA;
+Standardwert: \verb;WSPLGEN.STA;
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Parameter -PROT (Protokoll)}\label{subsubsec:param-prot}
@@ -689,12 +712,14 @@
Beispiel: \verb;-PROT=C:\TEMP\WSPLGEN.LOG;
+Standardwert: \verb;WSPLGEN.LOG;
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Zwingend erforderliche Eingabedateien}
-Folgende Daten werden von WSPLGEN zwingend benötigt.
+Folgende Dateien werden von WSPLGEN zwingend benötigt.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -727,8 +752,34 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Ausgabedaten}
+\section{Ausgabedaten}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Rückgabewerte}
+
+Wenn WSPLGEN seine Arbeit ohne Fehler und Warnungen beenden kann, so wird
+der Rückgabewert 0 vom Programm zurückgeliefert und zeigt dem aufrufenden
+Programm oder der Eingabeaufforderung (Shell) an, das alles in Ordnung ist.
+
+Solle es aber zu einem Fehler oder einer Warnung gekommen sein, so wird
+ein positiver Rückgabewert in Abhängigkeit des Fehlers generiert.
+
+Will oder kann das aufrufenede Programm die Protokoll-Datei nicht auswerten,
+so kann und sollte es aufgrund des Rückgabewertes trotzdem eine für den Benutzer
+sinnvolle Fehlermeldung generieren.
+
+Die verschiedenen Rückgabewerte mit den entsprechenden Fehlermeldungen
+sind im Anhang~\ref{sec:fehlermeldungen} zusammengefasst.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Ausgabedateien}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\subsubsection{Datei Ergebnisse}\label{subsubsec:file-ausgabe}
Als Ausgabedaten generiert das Programm WSPLGEN bei fehlerfreier Ausführung
@@ -866,6 +917,130 @@
Das Programm WSPLGEN kommuniziert nur über die Kommandozeile und
verschiedene Ein- und Ausgabedateien mit der GUI.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{appendix}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section{Parameter}\label{sec:parameter}
+
+\begin{tabular}{|l|p{3.3cm}|p{2.6cm}|p{2.6cm}|p{4.4cm}|}\hline
+Parameter & Argumente & Typ & Einheit & Standardwert\\\hline
+PAR & Parameterdatei & Pfadangabe & - & - \\\hline
+DELTA & VON\newline BIS\newline DIFF & Kommazahl \newline Kommazahl \newline Kommazahl & Meter\newline Meter\newline Meter & 0\newline Maximaler Wasserstand\newline (BIS - VON) / 10 \\\hline
+GEL & Sperre & Auswahl & SPERRE \newline NOSPERRE & SPERRE \\\hline
+DGM & DGM-Datei & Pfadangabe & - & - \\\hline
+PRO & Profil-Datei & Pfadangabe & - & - \\\hline
+WSP & WSP-Datei & Pfadangabe & - & - \\\hline
+LIN & Linien-Datei & Pfadangabe & - & - \\\hline
+AUSGABE & Ausgabe-Datei & Pfadangabe & - & WSPLGEN.SHP \\\hline
+PROT & Protokol-Datei & Pfadangabe & - & WSPLGEN.STA \\\hline
+FORT & Fortschritts-Datei & Pfadangabe & - & WSPLGEN.LOG \\\hline
+\end{tabular}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section{Fehlermeldungen}\label{sec:fehlermeldungen}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Kein Fehler}
+
+Rückgabewert 0
+
+Fehlermeldung: Keine
+
+Beschreibung: Es hat weder Fehler noch Warnungen gegeben.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Fehlergruppe Parameterauswertung: 1xxx}
+
+Rückgabewert: 1101
+
+Fehlermeldung: Unbekannter Parameter
+
+Beschreibung: Es wurde ein Parameter verwendet, der dem Programm WSPLGEN unbekannt ist.
+
+Rückgabewert: 1202
+
+Warnung: Mehrfach verwendeter Parameter
+
+Beschreibung: Es wurde ein Parameter mehrfach verwendet. Es wird nur das erste Auftreten berücksichtigt.
+Es wird immer zuerst die komplette Kommandozeile bearbeitet, bevor die Parameterdatei ausgewertet wird.
+Diese Warnung kann leicht vorkommen, wenn ein Parameter sowohl auf der Kommandozeile angegeben wird,
+als auch in der Parameterdatei vorkommt.
+
+Rückgabewert: 1103
+
+Fehlermeldung: Argument fehlt
+
+Beschreibung: Es wurde kein Argument für einen Parameter angegeben. Das Gleichheitszeichen oder
+die Argumente nach dem Gleichheitszeichen fehlen. Möglicherweise wurden zuviele oder
+ungeschützte Leerzeichen verwendet (siehe Abschnit~\ref{subsec:param}.
+
+Rückgabewert: 1204
+
+Warnung: Parameter DELTA ohne Argumente aufgerufen
+
+Beschreibung: Der Parameter DELTA kann auch ohne Parameter aufgerufen werden. Es werden dann nur
+Standardwerte für alle drei Argemente verwendet. Wenn dies gewünscht ist, bracht der Parameter
+überhaupt nicht angegeben zu werden. Das er doch gefunden wurde, könne an einer falschen Aufrufsyntax liegen.
+Es könnte das Gleichheitszeichen fehlen oder es könnten zuviele Leerzeichen eingefügt worden sein.
+
+Rückgabewert: 1205
+
+Fehlermeldung: VON ist kleiner als BIS
+
+Erklärung: Das Argument VON ist größer als das Argument BIS. Die Reihenfolge der Argumente
+wurde wahrscheinlich nicht beachtet. Zuerst kommt VON, dann BIS, dann DIFF.
+
+Rückgabewert: 1206
+
+Fehlermeldung: DIFF ist kleiner als 0
+
+Erklärung: Das Argument DIFF muss immer größer gleich 0 sein.
+
+Rückgabewert: 1207
+
+Fehlermeldung: DIFF ist gleich 0, aber VON und BIS sind verschieden.
+
+Erklärung: Das Argument DIFF darf nur den Wert 0 haben, wenn VON und BIS gleich sind. Sind VON und BIS verschieden,
+so wäre eine Abstufung in Schitten zu 0 Metern sinnlos.
+
+Rückgabewert: 1208
+
+Warnung: DIFF ist größer als die Differenz von BIS und VON
+
+Erklärung: DIFF wird vom Programm ignoriert und nur eine Wasserstandsisolinie mit dem Wert VON generiert.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Fehlergruppe Dateifehler: 2xxx}
+
+Rückgabewert: 2101
+
+Warnung: Eine Eingabedatei könnte nicht zum Lesen geöffnet werden.
+
+Erklärung: WSPLGEN hta versucht eine Eingabedatei zum Lesen zu öffnen, was nicht funktioniert hat.
+Die wahrscheinlichsten Ursachen sind, dass die angegebene Datei nicht existiert (also der Dateipfad
+falsch ist) oder das Programm (bzw. der Benutzer) nicht genug Rechte hat die Datei zum Lesen zu öffnen.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\end{appendix}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\end{document}
More information about the Wsplgen-commits
mailing list