[Wsplgen-commits] r25 - trunk/doc/Feinkonzept
scm-commit at wald.intevation.org
scm-commit at wald.intevation.org
Mon Jan 9 21:37:26 CET 2006
Author: mrchip
Date: 2006-01-09 21:37:25 +0100 (Mon, 09 Jan 2006)
New Revision: 25
Modified:
trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex
Log:
Die Struktur wurde etwas vereinfacht und die Beschreibungn etwas gek?\195?\188rzt. Die Tabellen wurden ohne Linien formatiert.
Modified: trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex
===================================================================
--- trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex 2006-01-08 23:28:55 UTC (rev 24)
+++ trunk/doc/Feinkonzept/WSPLGEN-Feinkonzept.tex 2006-01-09 20:37:25 UTC (rev 25)
@@ -33,9 +33,9 @@
\RCS$Id$
\RCS$Revision$
-\newcommand{\documentdate}{08. Januar 2006}
+\newcommand{\documentdate}{09. Januar 2006}
\newcommand{\documentrevision}{\RCSRevision}
-\newcommand{\documentversion}{0.6.1}
+\newcommand{\documentversion}{0.6.2}
\newcommand{\documentID}{\RCSId}
%----------------------------------------------
@@ -242,62 +242,64 @@
% START YOUR DOCUMENT HERE!
-\newpage
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
+\newpage
\section{Allgemeines}
Das Programm WSPLGEN erzeugt Dateien im ESRI Shape Format, um eine flächige
Darstellung der Ergebnisse eindimensionaler mathematischer Modelle zur
Berechnung von Wasserständen zu ermöglichen.
-Das Programm WSPLGEN wird als eigenständiges Programm realisiert.
-Es kann dann von Bedieneroberflächen (Graphic-User-Interfaces, GUIs)
-aufgerufen werden und liefert seine
-Ergebnisse in verschiedenen Dateien für die anschließende Visualisierung.
+Es wird als eigenständiges Programm realisiert und kann
+von einer Bedieneroberfläche (Graphic-User-Interfaces, GUI)
+aufgerufen werden.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+Die Eingabedaten werden in der grafischen Bedieneroberfläche definiert und
+per Kommandozeilenparameter oder Parameterdatei und über verschiedene
+Eingabedateien an das Programm WSPLGEN übergeben. Eine erste Überprüfung
+auf Vollständigkeit und Sinnhaftigkeit sollte in der GUI erfolgen, da WSPLGEN
+bei den meisten Problemen nur einen Fehler generiert oder Standardwerte benutzt,
+die nicht immer den eigentlichen Willen des Benutzers wiedergeben. Beim
+Verwenden von Standardwerten wird in jedem Fall eine Warnung generiert.
-\subsection{Vorgehensweise}
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Vorgehensweise}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\refstepcounter{schritt}
-\subsubsection{Schritt \theschritt ~-~Auswertung der Kommandozeilenparameter}
+\subsection{Schritt \theschritt ~-~Auswertung der Kommandozeilenparameter}
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} und Abschnitt~\ref{sec:fehlermeldungen}).
+(sihe 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
+Parameterdatei (siehe Abschnitt \ref{subsec:param-par}), so wird
nur das erste Auftreten in der Kommandozeile berücksichtigt und eine Warnung
-generiert (siehe Abschnitt~\ref{subsubsec:file-prot} und Abschnitt~\ref{sec:fehlermeldungen}).
+generiert (siehe Abschnitt~\ref{sec:fehlermeldungen}).
Die zulässigen Kommandozeilenoptionen und ihre Argumente werden im
-Abschnitt~\ref{subsec:param} und im Anhang~\ref{sec:parameter} beschrieben.
+Abschnitt~\ref{sec:param} und im Anhang~\ref{sec:parameter} beschrieben.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\refstepcounter{schritt}\label{schritt:einlesen}
-\subsubsection{Schritt \theschritt~-~Einlesen der Eingabedaten}\label{subsubsec:schritt-einlesen}
+\subsection{Schritt \theschritt~-~Einlesen der Eingabedaten}\label{subsubsec:schritt-einlesen}
Die wichtigsten Kommandozeilenparameter bestimmen, welche Dateien das Programm
einlesen soll und in welche Dateien es die Ausgaben schreiben soll.
Wird das Programm angewiesen eine Datei zu lesen, die nicht existiert, die
aus einem anderen Grund (z.B. ungenügende Rechte) nicht gelesen werden kann
oder die in einem unbekannten oder fehlerhaften Format vorliegt, so wird
-eine Fehlermeldung generiert (siehe Abschnitt~\ref{subsubsec:file-prot}).
+eine Fehlermeldung generiert (siehe Abschnitt~\ref{sec:fehlermeldungen}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{Digitales Geländemodell (DGM)}
+\subsubsection{Digitales Geländemodell (DGM)}
-\verb; ;
-
WSPLGEN liest zuerst ein digitales Geländemodell (DGM) ein, das durch seine Größe
auch gleichzeitig die maximal mögliche Ausdehnung des Ergebnisses festlegt.
Das DGM muss für die weitere Bearbeitung als vermaschtes Netz vorliegen.
@@ -306,7 +308,7 @@
\Fig{\includegraphics[width=10cm,keepaspectratio]{abbildungen/abb_netz.eps}}{Ein ganz kleiner Ausschnitt aus einem DGM als vermaschtes Netz}{Ausschnitt eines DGM als vermschtes Netz}
\end{center}
-Die verschiedenen möglichen Formate des DGM werden in Abschnitt~\ref{subsubsec:file-dgm}
+Die verschiedenen möglichen Formate des DGM werden in Abschnitt~\ref{subsec:file-dgm}
genauer spezifiziert. Wird ein Format für das DGM gewählt, das kein vermaschtes Netz
darstellt (z.B. eine ASCII-Datei mit X,Y,Z-Tripeln), so wird nach dem Einlesen der Punkte
eine automatische Triangulierung durchgeführt (siehe Schritt~\ref{schritt:triang} in Abschnitt~\ref{subsubsec:schritt-triang}).
@@ -314,10 +316,8 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{Gewässerquerprofile}
+\subsubsection{Gewässerquerprofile}
-\verb; ;
-
Als nächstes wird die Lage der Gewässerquerprofile eingelesen.
Die Gewässerquerprofile müssen so lang sein, dass an ihren Enden eine Geländehöhe
im DGM vorhanden ist, die sicher höher liegt, als die Wasserstände, die den Profilen
@@ -342,30 +342,26 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{Wasserstände}
+\subsubsection{Wasserstände}
-\verb; ;
-
Als nächstes werden die Wasserstände eingelesen, die den Gewässerquerprofilen
zugeordnet sind. Sollte einem Gewässerquerprofil kein Wasserstand
direkt zugeordnet werden können, so wird versucht, einen Wasserstand linear
aus stromauf und stromab liegenden Wasserständen zu interpolieren. Sollte
dies nicht möglich sein, weil entweder kein stromauf oder kein
stromab liegender Wasserstand definiert wurde, so wird eine Fehlermeldung
-generiert (siehe Abschnitt~\ref{subsubsec:file-prot}) und das Programm beendet.
+generiert (siehe Abschnitt~\ref{subsec:file-error}) und das Programm beendet.
Es kann immer nur ein Wasserstand pro Profil verwendet werden. Sollten doch
mehrere Wasserstände einem Profil zugeordnet sein, so wird nur der erste
Wasserstand verwendet und eine entsprechende Warnung generiert
-(siehe Abschnitt~\ref{subsubsec:file-prot}).
+(siehe Abschnitt~\ref{subsec:file-error}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{Sperren und Brüche (optional)}
+\subsubsection{Sperren und Brüche (optional)}
-\verb; ;
-
Um sowohl Brüche als auch den Neubau von Hochwasserschutzdämmen simulieren
zu können ohne das DGM verändern zu müssen, ist es möglich, eine weitere
Datei mit Linien im ESRI SHAPE-Format einzulesen.
@@ -378,23 +374,20 @@
Linie transportiert wird.
,,Sperren'' bzw. ,,Brüche'' können nicht zusammen mit der Option \verb;-GEL=NOSPERRE;
-verwendet werden (siehe Abschnitt~\ref{subsubsec:param-gel}).
+verwendet werden (siehe Abschnitt~\ref{subsec:param-gel}).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-
\refstepcounter{schritt}\label{schritt:triang}
-\subsubsection{Schritt \theschritt~-~Triangulierung (optional)}\label{subsubsec:schritt-triang}
+\subsection{Schritt \theschritt~-~Triangulierung (optional)}\label{subsubsec:schritt-triang}
Wird das DGM nicht in einem Format zur Verfügung gestellt, das ein
vermaschtes Netz repräsentiert, sondern nur unabhängige Knoten, so wird
von WSPLGEN ein vermaschtes Netz erzeugt.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\refstepcounter{schritt}\label{schritt:verdichten}
-\subsubsection{Schritt \theschritt~-~Verdichtung der Wasserstände}\label{subsubsec:schritt-verdichten}
+\subsection{Schritt \theschritt~-~Verdichtung der Wasserstände}\label{subsubsec:schritt-verdichten}
Es wird von sinnvoll geknickten Querprofilen ausgegangen, die
ein lineares Interpolieren von zusätzlichen Querprofilen zwischen
@@ -419,9 +412,8 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\refstepcounter{schritt}\label{schritt:uebertragen}
-\subsubsection{Schritt \theschritt~-~Übertragung der Wasserstände auf das DGM}\label{subsubsec:schritt-uebertragen}
+\subsection{Schritt \theschritt~-~Übertragung der Wasserstände auf das DGM}\label{subsubsec:schritt-uebertragen}
Nachdem für eine ausreichende Zahl von Profilen die Wasserstände festgelegt wurden,
werden die Wasserstände auf das DGM übertragen. Dabei wird versucht jedem Punkt des DGM,
@@ -457,9 +449,8 @@
\end{center}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\refstepcounter{schritt}\label{schritt:extrapolation}
-\subsubsection{Schritt \theschritt~-~Extrapolation der Wasserstände}\label{subsubsec:schritt-extrapolation}
+\subsection{Schritt \theschritt~-~Extrapolation der Wasserstände}\label{subsubsec:schritt-extrapolation}
Die Extrapolation der Wasserstände, die auf das DGM übertragen wurden,
erfolgt iterativ entlang der verbindenden Kanten zwischen den Knoten
@@ -481,7 +472,7 @@
Wenn eine Datei mit Sperren angegeben wird, so werden vor dem Beginn der Extrapolation
alle Kanten des DGM entfernt, die als Sperren gekennzeichnete Polylinien schneiden
-(siehe Abschnitt~\ref{subsubsec:file-sperr}). Durch dieses Löschen können Wasserstände die
+(siehe Abschnitt~\ref{subsec:file-sperr}). Durch dieses Löschen können Wasserstände die
Sperre nicht überwinden.
\begin{center}
@@ -490,16 +481,15 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\refstepcounter{schritt}\label{schritt:isolinien}
-\subsubsection{Schritt \theschritt~-~Generierung der Isolinien gleicher Wasserstände}\label{subsubsec:schritt-isolinien}
+\subsection{Schritt \theschritt~-~Generierung der Isolinien gleicher Wasserstände}\label{subsubsec:schritt-isolinien}
In diesem Schritt brauchen nur die Kanten ermittelt zu werden, die einen nassen
und einen trockenen Knoten verbinden. Es wird für jede dieser Kanten der Punkt bestimmt,
an dem die Wassertiefe gleich Null ist. Alle so ermittelten Punkte werden verbunden
und ergeben die gewünschte Isolinie.
-Um die gewünschten Abstufungen zu erreichen (vgl. Abschnitt~\ref{subsubsec:param-delta}), werden
+Um die gewünschten Abstufungen zu erreichen (vgl. Abschnitt~\ref{subsec:param-delta}), werden
die Geländehöhen des DGM schrittweise um die gewünschte Schrittweite \verb;<Diff>; angehoben
und die Schritte~\ref{schritt:extrapolation} und \ref{schritt:isolinien} so lange
wiederholt, bis die gewünschte maximale Wassertiefe erreicht ist. Ist die Startwassertiefe
@@ -508,36 +498,38 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\refstepcounter{schritt}
-\subsubsection{Schritt \theschritt~-~Schreiben der Ausgabedaten}
+\subsection{Schritt \theschritt~-~Schreiben der Ausgabedaten}
Nachdem intern die Polygone gebildet wurden, die die verschiedenen Wassertiefen repräsentieren,
-werden sie in eine Ergebnisdatei geschrieben, die über die Kommandozeile mit dem Parameter \verb;-ERG;
-definiert wurde (siehe Abschnitt~\ref{subsubsec:param-ausgabe}). Wird der Parameter nicht angegeben,
-so wird die Datei WSPLGEN.SHP erzeugt (siehe Abschnitt~\ref{subsubsec:param-ausgabe}).
-Das Format der Ausgabedatei wird genauer in Abschnitt~\ref{subsubsec:file-ergebnisse} beschrieben.
+werden sie in eine Ergebnisdatei geschrieben, die über die Kommandozeile definiert wird
+(siehe Abschnitt~\ref{subsec:param-ausgabe}). Wird der Parameter nicht angegeben,
+so wird die Datei WSPLGEN.SHP erzeugt (siehe Abschnitt~\ref{subsec:param-ausgabe}).
+Das Format der Ausgabedatei wird genauer in Abschnitt~\ref{subsec:file-ergebnisse} beschrieben.
+Während des Laufs von WSPLGEN wird der akutelle Bearbeitungsstand kontinuierlich in die
+Standardausgabe (stdout) geschrieben, so dass die GUI in der Lage ist,
+ihn anzuzeigen.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+Warnungen und maximal ein Fehler (da nach einem Fehler das Programm sofort beendet wird), werden in die
+Standardausgabe für Fehler (stderr) geschrieben, und sollten von der GUI angezeigt werden,
+so dass der Benutzer nach dem Beenden von WSPLGEN überprüfen kann,
+ob alles zu seiner Zufriedenheit erledigt werden konnte oder es Probleme gegeben hat.
-\newpage
-\section{Eingabedaten}
+Eine direkte Interaktion mit dem Programm WSPLGEN ist nicht vorgesehen.
+Sollte es also einen Fehler oder Warnungen gegeben haben, die der Benutzer
+nicht ignorieren will, so muss er die Eingabedaten oder Parameter
+ändern und einen erneuten Lauf starten. Die Meldungen sind aber
+so aussagekräftig, dass sie dem Benutzer optimale Hinweise für sein
+weiteres Vorgehen liefern.
-Die Eingabedaten werden in der grafischen Bedieneroberfläche definiert und
-per Kommandozeilenparameter oder Parameterdatei und über verschiedene
-Eingabedateien an das Programm WSPLGEN übergeben. Eine erste Überprüfung
-auf Vollständigkeit und Sinnhaftigkeit sollte in der GUI erfolgen, da WSPLGEN
-bei den meisten Problemen nur einen Fehler generiert
-(siehe Abschnitt~\ref{subsubsec:file-prot}) oder Standardwerte benutzt,
-die nicht immer den eigentlichen Willen des Benutzers wiedergeben. Beim
-Verwenden von Standardwerten wird in jedem Fall eine Warnung generiert und
-in die Protokolldatei geschrieben (siehe Abschnitt~\ref{subsubsec:file-prot}).
+Nur wenn es keinen Fehler gegeben hat, wird eine Shape-Datei erzeugt,
+die in einer GUI visualisiert werden kann.
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{Kommandozeilen Parameter}\label{subsec:param}
+\newpage
+\section{Kommandozeilen Parameter}\label{sec:param}
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
@@ -554,7 +546,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{PAR (Parameterdatei)}\label{subsubsec:param-par}
+\subsection{PAR (Parameterdatei)}\label{subsec:param-par}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Angabe einer Parameterdatei zur Definition weiterer Parameter}\\
@@ -565,6 +557,8 @@
{\bf Beispiel} & \multicolumn{4}{l}{-PAR=WSPLGEN.PAR}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Da die Eingabe von Kommandozeilen über Windows einer Längenbeschränkung unterliegt,
was in Kombination mit langen Pfadnamen leicht zu Problemen führen kann, wird auch die
Zusammenfassung aller Parameter in einer Parameterdatei vorgesehen.
@@ -580,7 +574,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{DELTA (Abstufungen der Wassertiefen)}\label{subsubsec:param-delta}
+\subsection{DELTA (Abstufungen der Wassertiefen)}\label{subsec:param-delta}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Abstufungen der Wassertiefen}\\
@@ -593,6 +587,8 @@
{\bf Beispiel} & \multicolumn{4}{l}{-DELTA=1.0,2.0,0.25}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Die Option \verb;-DELTA; bestimmt, in welchen Abstufungen die Wassertiefenpolygone
generiert werden sollen, die Isolinien gleicher Wassertiefe repräsentieren.
Die entsprechenden Wassertiefen werden aus den Argumenten \verb;<Von>;, \verb;<Bis>; und \verb;<Diff>;
@@ -649,7 +645,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Parameter -GEL (Einfluss von Geländeerhebungen)}\label{subsubsec:param-gel}
+\subsection{GEL (Einfluss von Geländeerhebungen)}\label{subsec:param-gel}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Auswahl wie Geländeerhebungen berücksichtigt werden}\\
@@ -660,13 +656,15 @@
{\bf Beispiel} & \multicolumn{4}{l}{-GEL=NOSPERRE}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Die Option \verb;-GEL; bestimmt, ob die Wasserstände durch Geländeerhebungen
hindurch getragen werden sollen. Dies würde ein potenziel gefährdetes Gebiet im Hinterland
produzieren, in dem der Wasserstand in etwa den Gradienten des Flusses aufweisen würde
(keine sinnvolle Wiedergabe von eingestauten Flächen). Eine
-Kombination mit den Daten aus Abschnitt~\ref{subsubsec:param-lin} ist nicht sinnvoll und sollte in der GUI
+Kombination mit den Daten aus Abschnitt~\ref{subsec:param-lin} ist nicht sinnvoll und sollte in der GUI
verhindert werden. Wird der Parameter mit ,,Sperren'' bzw. ,,Brüchen'' angegeben und das Argument
-des Parameters \verb;-GEL; ist SPERRE, wird eine Fehler generiert (siehe Abschnitt~\ref{subsubsec:file-prot}).
+des Parameters \verb;-GEL; ist SPERRE, wird eine Fehler generiert (siehe Abschnitt~\ref{subsec:file-error}).
Wird der Parameter \verb;-GEL; nicht angegeben, so wird der Wert \verb;SPERRE; angenommen.
Es wird dann also mit Einstau gearbeitet.
@@ -674,7 +672,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{DGM (Digitales Geländemodell)}\label{subsubsec:param-dgm}
+\subsection{DGM (Digitales Geländemodell)}\label{subsec:param-dgm}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Angabe einer DGM-Datei}\\
@@ -685,6 +683,8 @@
{\bf Beispiel} & \multicolumn{4}{l}{-DGM=DGM.XYZ}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Das Format der Daten wird von dem Programm WSPLGEN selbst erkannt und
eine Plausibilitäts\-prüfung des DGM vorgenommen.
@@ -706,7 +706,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{PRO (Lage der Querprofile)}\label{subsubsec:param-profile}
+\subsection{PRO (Lage der Querprofile)}\label{subsec:param-profile}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Angabe einer Querprofillagen-Datei}\\
@@ -717,6 +717,8 @@
{\bf Beispiel} & \multicolumn{4}{l}{-PRO=WESER120-129.SHP}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Mit der Optionen \verb;-PRO; wird bestimmt, mit welcher Datei die Lage der
Querprofile definiert wird.
@@ -735,7 +737,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{WSP (Wasserstände)}\label{subsubsec:param-wsp}
+\subsection{WSP (Wasserstände)}\label{subsec:param-wsp}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Angabe einer Wasserstands-Datei}\\
@@ -746,6 +748,8 @@
{\bf Beispiel} & \multicolumn{4}{l}{-WSP=HQ5-120-129.TXT}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Mit der Optionen \verb;-WSP; wird bestimmt, mit welcher Datei die Wasserstände
definiert werden, die den Querprofilen zugeordnet werden sollen.
@@ -761,7 +765,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{LIN (Sperren und Brüche)}\label{subsubsec:param-lin}
+\subsection{LIN (Sperren und Brüche)}\label{subsec:param-lin}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Angabe einer Datei mit ,,Sperren'' und/oder ,,Brüchen''}\\
@@ -772,13 +776,15 @@
{\bf Beispiel} & \multicolumn{4}{l}{-LIN=BREAK.SHP}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Mit der Optionen \verb;-LIN; wird bestimmt, mit welcher Datei die ,,Sperren''
bzw. ,,Durchbrüche'' definiert werden.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{AUSGABE (Ausgabedatei)}\label{subsubsec:param-ausgabe}
+\subsection{AUSGABE (Ausgabedatei)}\label{subsec:param-ausgabe}
\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
{\bf Kurzfassung} & \multicolumn{4}{l}{Ausgabedatei}\\
@@ -789,71 +795,40 @@
{\bf Beispiel} & \multicolumn{4}{l}{-WSP=000-100.SHP}\\
\end{tabular}
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
Als Ausgabedaten generiert das Programm WSPLGEN bei fehlerfreier Ausführung
eine Shape-Datei, in der Polygone enthalten sind, deren Grenzen Isolinien
-gleicher Wassertiefe repräsentieren (siehe Abschnitt~\ref{subsubsec:file-ergebnisse}). Wird
+gleicher Wassertiefe repräsentieren (siehe Abschnitt~\ref{subsec:file-ergebnisse}). Wird
dieser Parameter nicht angegeben, so wird als Ausgabedateiname ein Standardwert
angenommen.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\newpage
+\section{Zwingend erforderliche Eingabedateien}
-\subsubsection{FORT (Fortschritt)}\label{subsubsec:param-fort}
+Für alle Eingabedateien im ASCII-Format gilt:
-\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
-{\bf Kurzfassung} & \multicolumn{4}{l}{Fortschrittdatei}\\
-{\bf Format} & \multicolumn{4}{l}{-FORT=$<$Pfad$>$}\\
-{\bf Status} & \multicolumn{4}{l}{Optional}\\
-{\bf Argumente} & \em Name & \em Typ & \em Einheit & \em Standardwert\\
- & Pfad & Pfadangabe & - & WSPLGEN.STA \\
-{\bf Beispiel} & \multicolumn{4}{l}{-WSP=2005-11-02.STA}\\
-\end{tabular}
+\vspace{1cm minus 0.5cm}
-Während des Laufs von WSPLGEN wird der akutelle Bearbeitungsstand kontinuierlich in einer
-Fortschrittsdatei aktualisiert, so dass die GUI in der Lage ist,
-ihn anzuzeigen (siehe Abschnitt~\ref{subsubsec:file-fort}).
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\subsubsection{PROT (Protokoll)}\label{subsubsec:param-prot}
-
-\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
-{\bf Kurzfassung} & \multicolumn{4}{l}{Protokolldatei}\\
-{\bf Format} & \multicolumn{4}{l}{-PROT=$<$Pfad$>$}\\
-{\bf Status} & \multicolumn{4}{l}{Optional}\\
-{\bf Argumente} & \em Name & \em Typ & \em Einheit & \em Standardwert\\
- & Pfad & Pfadangabe & - & WSPLGEN.LOG \\
-{\bf Beispiel} & \multicolumn{4}{l}{-WSP=2005-11-02.LOG}\\
+\begin{tabular}{ll}
+{\bf Kopfzeile:} & Tripel bestehend aus den Attributnamen der Tabelle\\
+{\bf Weitere Zeilen:} & Tripel bestehend aus den Attributwerten\\
+{\bf Zeilenende:} & Newline und/oder carriage return\\
+{\bf Spaltentrenner:} & beliebig viele Leerzeichen und Tabulatoren\\
+{\bf Float:} & Ziffern von 0 bis 9, Dezimaltrenner: ',' der '.'\\
+{\bf Text:} & ASCII-Zeichen in einheitlichem Encoding\\
\end{tabular}
-In einer Protokolldatei werden Warnungen und maximal ein Fehler gespeichert
-(da nach jedem Fehler das Programm sofort beendet wird), so dass der
-Benutzer nach dem Beenden von WSPLGEN überprüfen kann, ob alles zu
-seiner Zufriedenheit erledigt werden konnte oder es Probleme gegeben hat.
-(siehe Abschnitt~\ref{subsubsec:file-prot}).
+\vspace{1cm minus 0.5cm}
-Eine direkte Interaktion mit dem Programm WSPLGEN ist nicht vorgesehen.
-Sollte es also einen Fehler oder Warnungen gegeben haben, die der Benutzer
-nicht ignorieren will, so muss er die Eingabedaten oder Parameter
-ändern und einen erneuten Lauf starten. Die Meldungen sind aber
-so aussagekräftig, dass sie dem Benutzer optimale Hinweise für sein
-weiteres Vorgehen liefern (siehe Abschnitt~\ref{subsubsec:file-prot}).
-
-Nur wenn es keinen Fehler gegeben hat, wird eine Shape-Datei erzeugt,
-die in einer GUI visualisiert werden kann.
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\subsection{Zwingend erforderliche Eingabedateien}
-
Folgende Dateien werden von WSPLGEN zwingend benötigt.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Datei Digitales Geländemodell (DGM)}\label{subsubsec:file-dgm}
+\subsection{Datei Digitales Geländemodell (DGM)}\label{subsec:file-dgm}
Das digitale Geländemodell darf in drei verschiedenen Dateiformaten vorliegen,
die im Folgenden näher beschrieben werden.
@@ -861,56 +836,30 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{ASCII-Format mit X,Y,Z-Tripeln}
+\subsubsection{ASCII-Format mit X,Y,Z-Tripeln}
-\verb; ;
-
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
+\begin{tabular}{lp{4cm}lcl}
{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
-\hline
X & X-Koordinate & Float(10.2) & - & m \\
Y & Y-Koordinate & Float(10.2) & - & m \\
Z & Z-Koordinate & Float(10.2) & - & m \\
-\hline
\end{tabular}
-Das einfachste Format ist ein Format, das nur eine Kopfzeile und danach Tripel von Zahlen enthält,
-die die X- und Y-Koordinaten von Geländepunkten und als Z-Wert die Geländehöhe angeben.
+\vspace{1cm minus 0.5cm}
Format Beschreibung:
-Die Zeichen 'X', 'Y' und 'Z' bestimmen die Spalten für die entsprechenden Werte und stehen in der Kopfzeile.
-Die Ziffern '0' bis '9' und die Zeichen ',' oder '.' (\textit{Kommazeichen}) dienen der Bildung von Zahlen.
-Beliebige Kombinationen von Leerzeichen und Tabulatoren (\textit{Trennzeichen}) dienen als Trennung
-zwischen den Spalten. Die Zeilenenden werden durch das Zeichen 'Neue Zeile' (Newline) und/oder
-'Wagenrücklauf' (carriage return) (\textit{Zeilenendzeichen}) beendet.
+Die Dateien in diesem Format, haben nur eine Kopfzeile und danach Tripel von Zahlen,
+die die X- und Y-Koordinaten von Geländepunkten und als Z-Wert die Geländehöhe angeben.
Leerzeilen, also Zeilen, die nur aus \textit{Trennzeichen} und \textit{Zeilenendzeichen} gebildet werden,
werden einfach überlesen.
-Jede Datei in diesem Format hat genau eine Kopfzeile, in der die Zeichen 'X', 'Y' und 'Z'
-jeweils genau einmal vorkommen müssen und durch mindestens ein Leerzeichen oder einen Tablulator
-getrennt werden. Diese Zeile muss genau wie alle weiteren durch die \textit{Zeilenendzeichen} beendet werden.
-
-In allen weiteren Zeilen stehen 3 Zahlen, die durch \textit{Trennzeichen} getrennt sind.
-Die Zahlen müssen mit einer Ziffer beginnen und dürfen einmal ein \textit{Kommazeichen} aufweisen.
-Nach dem \textit{Kommazeichen} dürfen wieder beliebig viele Ziffern folgen, wobei nur 2 Nachkommazeichen ausgewertet werden.
-Die Zahlen werden sonst auf- oder abgerundet. Da im Allgemeinen davon auszugehen ist, dass es sich bei den
-X- und Y- Koordinaten und den Z-Werten um Meterangaben handelt, ist eine Genauigkeit von 1 cm für
-die hydraulischen Fragestellungen voll ausreichend.
-
-Die Zahlen, die die Z-Koordinaten repräsentieren, dürfen auch mit dem Zeichen '\verb;-;' beginnen,
-um negative Zahlen darzustellen. Nach dem Zeichen '\verb;-;' mussaber immer erst wieder eine Ziffer folgen.
-
Welche Zahl in einer Zeile welche Bedeutung hat, wird durch die Reihenfolge der Zeichen 'X', 'Y' und 'Z' in der
Kopfzeile bestimmt.
Jede weitere Zahl oder jedes weitere Zeichen in einer Zeile werden ignoriert.
-Für die Anzahl der Zahlentripel gibt es im Moment nur die 32-Bit Grenze von 2.147.483.647 als programmtechnische Begrenzung.
-Diese dürfte im Moment weit über den Verarbeitungsmöglichkeiten aktueller Computern liegen.
-
Format Beispiele:
Dies wäre eine 'normale' Datei.
@@ -936,14 +885,10 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{ESRI ASCII Raster-Datei-Format}
+\subsubsection{ESRI ASCII Raster-Datei-Format}
-\verb; ;
-
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
+\begin{tabular}{lp{4cm}lcl}
{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
-\hline
NCOLS & Anzahl Spalten & Integer(8) & - & - \\
NROWS & Anzahl Reihen & Integer(8) & - & - \\
XLLCorner & X-Koordinate & Float(10.2) & - & m \\
@@ -952,9 +897,10 @@
YLLCenter & Y-Koordinate & Float(10.2) & - & m \\
NODATAVALUE & Z-Wert & Float(10.2) & - & - \\
Z & Z-Wert & Float(10.2) & - & m \\
-\hline
\end{tabular}
+\vspace{1cm minus 0.5cm}
+
Als weiteres gültiges Format für die DGM-Daten kann das ESRI ASCII Raster-Datei-Format (Grid-Format)
verwendet werden.
@@ -1008,23 +954,20 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{ESRI TIN-Format}
+\subsubsection{ESRI TIN-Format}
-\verb; ;
-
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
+\begin{tabular}{lp{4cm}lcl}
{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
-\hline
X & X-Koordinate & Float mit 8-Bytes & - & m \\
Y & Y-Koordinate & Float mit 8-Bytes & - & m \\
Z & Z-Koordinate & Float mit 4-Bytes & - & m \\
Nr1 & Punkt-Nr & Integer mit 4 Bytes & - & - \\
Nr2 & Punkt-Nr & Integer mit 4 Bytes & - & - \\
Nr3 & Punkt-Nr & Integer mit 4 Bytes & - & - \\
-\hline
\end{tabular}
+\vspace{1cm minus 0.5cm}
+
Beim TIN-Format (Triangulated Irregular Netzwork, unregelmßig vermaschtes Netz aus Dreiecken) werden
die Daten in verschiedenen Dateien abgespeichert, die alle in einem Ordner liegen, der mit seinem Namen
den Namen des TINs bestimmt. Die Dateinamen für ein TIN stehen fest. Für das einfache vermaschte Netz
@@ -1042,42 +985,43 @@
Im ASCII-format würden die Dateien z.B. so aussehen, wenn das Netz 5 Punkte und 3 Dreiecke enthält.
-\verb;tnxy.adf;
-
+\begin{verbatim}
+tnxy.adf
3456453.23 5345312.13
3456465.12 5345323.34
3456423.02 5345328.46
3456412.34 5345328.21
3456412.00 5345393.02
-\verb;tnz.adf;
-
+tnz.adf
11.23
22.23
15.33
29.43
25.34
-\verb;tnod.adf;
-
+tnod.adf
1 2 3
1 3 5
3 4 4
+\end{verbatim}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Datei Lage der Querprofile}\label{subsubsec:file-profile}
+\subsection{Datei Lage der Querprofile}\label{subsubsec:file-profile}
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
-{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\\hline
+\begin{tabular}{lp{4cm}lcl}
+{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
X & X-Koordinate & Float(10.2) & - & m \\
Y & Y-Koordinate & Float(10.2) & - & m \\
GEW & Gewässerbeschreibung & Text(255) & - & - \\
STATION & Stationierung & Float(10.4) & $>$ 0 & km \\
-\hline
\end{tabular}
+\vspace{1cm minus 0.5cm}
+
+Format Beschreibung:
+
Die Lage der Gewässerquerprofile wird immer als Polylinien-Thema in einer
Shape-Datei übergeben, wobei es egal ist, ob der Typ des Polylinien-Themas
ARC, ARCZ oder ARCM ist. Die Profile (Polylinien) können dabei aus beliebig
@@ -1086,8 +1030,6 @@
Vorland bei Köln, 102,242). Die beiden Angaben sind notwendig, damit das Programm WSPLGEN
weitere benötigte Profile selbstständig interpolieren kann.
-Format Beschreibung:
-
Die beiden Werte für Gewässer und Station werden gespeichert in den
Attributen \verb;GEW;, vom Typ Text (String) mit einer Länge von
maximal 255 Zeichen und \verb;STATION;, das vom Typ Fließkommazahl (Float) ist
@@ -1114,24 +1056,19 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Datei Wasserstände}\label{subsubsec:file-wsp}
+\subsection{Datei Wasserstände}\label{subsec:file-wsp}
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
+\begin{tabular}{lp{4cm}lcl}
{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
-\hline
GEW & Gewässername & Text(255) & - & - \\
STATION & Stationierung & Float(10.4) & $>$ 0 & km \\
WSP & Wasserstand & Float(10.4) & $>$ 0 & m\\
-\hline
\end{tabular}
+\vspace{1cm minus 0.5cm}
+
Dateiformat: ASCII oder DBase-Format (DBF-Format)
-Für die Anzahl der Datensätze gibt es im Moment nur die 32-Bit Grenze von
-2.147.483.647 als programmtechnische Begrenzung. Diese dürfte im Moment
-weit über den Verarbeitungsmöglichkeiten aktueller Computern liegen.
-
Die Wasserstände müssen den Gewässerprofilen zugeordnet werden können, wobei
keine direkte Zuordnung notwendig ist. Es reicht aus, wenn Wasserstände
für Gewässserprofile linear interpoliert werden können, es also einen
@@ -1150,49 +1087,24 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{ASCII-Format}\label{file-ascii-wsp}
+\subsubsection{ASCII-Format}
-\verb; ;
-
Das einfachste Format ist ein Format, das nur eine Kopfzeile und danach Tripel von Texten und Zahlen enthält,
die das Gewässer, die Station und den Wasserstand beschreiben.
Die Zeichenketten 'GEW', 'STATION' und 'WSP' bestimmen die Spalten für die entsprechenden Werte und stehen in der Kopfzeile.
-Die Zeichen, die für die Gewässerkennzeichnung verwendet werden, sollten ASCII-Codes
-von 33 ('\verb;!;') bis 126 ('\verb;~;') sein. Werden Umlaute oder andere Sonderzeichen wie
-z.B. '\verb;ß;' verwendet, so ist dafür Sorge zu tragen, dass in der Datei, die die Lage der
-Profile definiert, die gleiche Kodierung verwendet wird.
-
-Die Ziffern '0' bis '9' und die Zeichen ',' oder '.' (\textit{Kommazeichen}) dienen der Bildung von Zahlen.
-Beliebige Kombinationen von Leerzeichen und Tabulatoren (\textit{Trennzeichen}) dienen als Trennung
-zwischen den Spalten. Die Zeilenenden werden durch das Zeichen 'Neue Zeile' (Newline) und/oder
-'Wagenrücklauf' (carriage return) (\textit{Zeilenendzeichen}) beendet.
-
Leerzeilen, also Zeilen, die nur aus \textit{Trennzeichen} und \textit{Zeilenendzeichen} gebildet werden,
werden überlesen.
-Jede Datei in diesem Format hat genau eine Kopfzeile, in der die Zeichenketten 'GEW', 'STATION' und 'WSP'
-jeweils genau einmal vorkommen müssen und durch mindestens ein Leerzeichen oder einen Tablulator
-getrennt werden. Diese Zeile muss genau wie alle weiteren durch die \textit{Zeilenendzeichen} beendet werden.
-
-In allen weiteren Zeilen stehen eine Zeichenkette und zwei Zahlen, die durch \textit{Trennzeichen} getrennt sind.
-
Die Zeichenkette darf nur dann Leerzeichen enthalten, wenn sie durch das Zeichen '\verb;";' am Anfang und am Ende geschützt ist.
Das Zeichen '\verb;";' wird nicht mit in die Zeichenkette aufgenommen.
-Die Zahlen müssen mit einer Ziffer beginnen und dürfen einmal als \textit{Kommazeichen} das Zeichen '.' oder ',' aufweisen.
-Nach dem \textit{Kommazeichen} dürfen wieder beliebig viele Ziffern folgen, wobei nur 4 Nachkommazeichen sinnvoll sind,
-da die Stationen auf 4 Nachkommastellen auf- bzw. abgerundet werden.
-
Welche Zahl in einer Zeile welche Bedeutung hat, wird durch die Reihenfolge der Zeichenketten 'GEW', 'STATION' und 'WSP' in der
Kopfzeile bestimmt.
Jede weitere Zahl oder jedes weitere Zeichen in einer Zeile werden ignoriert.
-Für die Anzahl der Tripel gibt es im Moment nur die 32-Bit Grenze von 2.147.483.647 als programmtechnische Begrenzung.
-Diese dürfte im Moment weit über den Verarbeitungsmöglichkeiten aktueller Computern liegen.
-
Format Beispiele:
\begin{verbatim}
@@ -1214,55 +1126,37 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\paragraph{DBF-Format}
+\subsubsection{DBF-Format}
-\verb; ;
-
Dieses Format ist ein klassisches binäres Datenbankformat, das nur aus einem
Datenblatt besteht, das wiederum aus einer Definition und den anschließenden Daten besteht.
-Die Felder des Datenblattes, die das Gewässer, die Station und den Wasserstand definieren heissen
-genau wie beim ASCII-Format (siehe Abschnitt~\ref{file-ascii-wsp}) 'GEW', 'STATION' und 'WSP'.
-'GEW' ist hierbei als Zeichkette mit maximal 255 Zeichen definiert und 'STATION' und 'WSP' sind
-jeweils Zahlen, wobei 'STATION' maximal 4 Nachkommastellen haben sollte, da die Stationen
-auf 4 Nachkommastellen auf- bzw. abgerundet werden.
-
-Die Zeichen, die für die Gewässerkennzeichnung verwendet werden, sollten ASCII-Codes
-von 33 ('\verb;!;') bis 126 ('\verb;~;') sein. Werden Umlaute oder andere Sonderzeichen wie
-z.B. '\verb;ß;' verwendet, so ist dafür Sorge zu tragen, dass in der Datei, die die Lage der
-Profile definiert, die gleiche Kodierung verwendet wird.
-
-Für die Anzahl der Tripel gibt es im Moment nur die 32-Bit Grenze von 2.147.483.647 als
-programmtechnische Begrenzung. Diese dürfte im Moment weit über den Verarbeitungsmöglichkeiten
-aktueller Computern liegen.
-
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\newpage
+\section{Optionale Eingabedateien}
-\subsection{Optionale Eingabedateien}
-
Optional können noch die folgenden Daten zur Feinsteuerung der
Arbeitsweise von WSPLGEN übergeben werden.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Datei Sperren und Durchbrüche}\label{subsubsec:file-sperr}
+\subsection{Datei Sperren und Durchbrüche}\label{subsec:file-sperr}
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
+\begin{tabular}{lp{4cm}lcl}
{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
-\hline
X & X-Koordinate & Float(10.2) & - & m \\
Y & Y-Koordinate & Float(10.2) & - & m \\
TYP & Art der Polylinie & Text(8) & SPERRE NOSPERRE & - \\
-\hline
\end{tabular}
+\vspace{1cm minus 0.5cm}
+
Diese Datei ist optional und dient nur dazu, dem Benutzer mehr Möglichkeiten
zu geben, die Ergebnisse zu beeinflussen
-(siehe Abschnitte~\ref{subsubsec:schritt-uebertragen} Schritt~\ref{schritt:uebertragen} und \ref{subsubsec:param-lin}).
+(siehe Abschnitte~\ref{subsubsec:schritt-uebertragen} Schritt~\ref{schritt:uebertragen}
+und \ref{subsec:param-lin}).
Formatbeschreibung:
@@ -1283,15 +1177,9 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\newpage
-\section{Ausgabedaten}
+\section{Rückgabewerte}
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\subsection{Rückgabewerte}
-
Wenn WSPLGEN seine Arbeit ohne einen Fehler und Warnungen beenden kann, so wird
als Rückgabewert vom Programm 0 zurückgeliefert, was dem aufrufenden
Programm oder der Eingabeaufforderung (Shell) anzeigt, das das Programm ohne
@@ -1300,6 +1188,9 @@
Sollte es aber zu einem Fehler oder einer Warnung gekommen sein, so wird
ein positiver Rückgabewert in Abhängigkeit des Fehlers generiert.
+Werden Warnung vom Programm erzeugt, so wird das Programm fortgesetzt und
+am Ende als Rückgabewert der Wert der {\bf ersten} Warnung zurückgegeben.
+
Will oder kann das aufrufende Programm die Protokoll-Datei nicht auswerten,
so kann und sollte es aufgrund des Rückgabewertes trotzdem eine für den Benutzer
sinnvolle Fehlermeldung generieren.
@@ -1308,29 +1199,26 @@
sind im Anhang~\ref{sec:fehlermeldungen} zusammengefasst.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Ausgabedateien}
-\subsection{Ausgabedateien}
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsection{Datei Ergebnisse}\label{subsec:file-ergebnisse}
-\subsubsection{Datei Ergebnisse}\label{subsubsec:file-ergebnisse}
-
-\begin{tabular}{|l|p{4cm}|l|l|l|}
-\hline
+\begin{tabular}{lp{4cm}lcl}
{\bf Name} & {\bf Beschreibung} &{\bf Datentyp} & {\bf Wertebereich} & {\bf Einheit}\\
-\hline
Diff & Wassertiefe & Float(10.2) & $>$ 0 & m \\
-\hline
\end{tabular}
+\vspace{1cm minus 0.5cm}
+
Als Ausgabedaten generiert das Programm WSPLGEN bei fehlerfreier Ausführung
eine Shape-Datei, in der Polygone enthalten sind, deren Umgrenzung Isolinien
-gleicher Wassertiefe repräsentieren (vgl. Abschnitt~\ref{subsubsec:param-delta}).
+gleicher Wassertiefe repräsentieren (vgl. Abschnitt~\ref{subsec:param-delta}).
Die Shape-Datei enthält als Attribut die repräsentierte Wassertiefe.
Der gewünschte Name der Shape-Datei (inkl. Pfadangaben) wird dem Programm
WSPLGEN wieder über die Kommandozeile durch den Parameter \verb;-AUSGABE;
-(siehe Abschnitt~\ref{subsubsec:param-ausgabe}) mitgeteilt.
+(siehe Abschnitt~\ref{subsec:param-ausgabe}) mitgeteilt.
Format Beschreibung:
@@ -1349,31 +1237,17 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Datei Fortschritt}\label{subsubsec:file-fort}
+\subsection{Datei Fortschritt}\label{subsec:file-fort}
-Während des Laufs von WSPLGEN wird der akutelle Bearbeitungsstand kontinuierlich in einer
-Fortschrittsdatei aktualisiert, so dass die GUI in der Lage ist,
-ihn anzuzeigen. In einer Protokolldatei werden Warnungen
-und Fehler gespeichert, so dass der Benutzer nach dem Lauf überprüfen
-kann, ob alles zu seiner Zufriedenheit erledigt werden konnte oder ob es
-Probleme gegeben hat.
+Während des Laufs von WSPLGEN wird der akutelle Bearbeitungsstand kontinuierlich in die
+Standardausgabe (stdout) geschrieben, so dass die GUI in der Lage ist,
+ihn anzuzeigen.
-Eine direkte Interaktion mit dem Programm WSPLGEN ist nicht vorgesehen.
-Sollte es also einen Fehler oder Warnungen gegeben haben, die der Benutzer
-nicht ignorieren will, so muss er die Eingabedaten oder Parameter
-ändern und einen erneuten Lauf starten. Die Meldungen sind aber
-so aussagekräftig, dass sie dem Benutzer optimale Hinweise für sein
-weiteres Vorgehen liefern (siehe Abschnitt~\ref{subsubsec:file-prot}).
+Aus diesem Grund schreibt WSPLGEN mmer wieder Text, der entweder in einer Zeile
+angibt was das Programm gerade tut oder in den folgenden Zeilen wie weit es damit ist.
-Format Beschreibung:
-
-Die Fortschrittdatei wird von dem Programm WSPLGEN sehr häufig
-geschrieben, da so eine aufrufende GUI die Möglichkeit hat, den Benutzer
-ständig auf dem Laufenden zu halten. Aus diesem Grund schreibt WSPLGEN
-in die Fortschrittdatei immer wieder Text, der entweder in einer Zeile angibt was das
-Programm gerade tut oder in den folgenden Zeilen wie weit es damit ist.
-
Format Beispiel:
+
\begin{verbatim}
->Lese DGM-Dateien
10000 Punkte gelesen (20% der Datei)
@@ -1403,13 +1277,13 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsubsection{Datei Protokoll}\label{subsubsec:file-prot}
+\subsection{Datei Fehler}\label{subsec:file-error}
-Die Protokolldatei wird von dem Programm WSPLGEN nur
+In die Standardfehlerausgabe (stderr) wird von dem Programm WSPLGEN nur
geschrieben, wenn es Warnungen oder sogar einen Fehler im Programm gab.
-Die Protokolldatei sollte dem Benutzer immer nach dem Lauf von WSPLGEN
-angezeigt werden, wenn sie existiert.
+Diese Warnungen oder der Fehler sollten dem Benutzer immer nach dem Lauf von WSPLGEN
+angezeigt werden.
Eine direkte Interaktion mit dem Programm WSPLGEN ist nicht vorgesehen.
Sollte es also Fehler oder Warnungen gegeben haben, die der Benutzer
@@ -1418,9 +1292,6 @@
so aussehen, dass sie dem Benutzer optimale Hinweise für sein
weiteres Vorgehen liefern.
-Wenn eine sinnvolle Shape-Datei erzeugt werden konnte (kein Fehler),
-so kann in einer GUI die weitere Visualisierung stattfinden.
-
Format Beschreibung:
Für jede Warnung wird eine Zeile der Form ,,\verb;->Warnung;'' in die Datei geschrieben,
@@ -1428,7 +1299,7 @@
Die Beschreibung endet mit der nächsten Warnung, einem Fehler oder dem Ende der Datei.
-Falls ein Fehler austritt wird eine Zeile der Form ,,\verb;->Fehler;'' in die Datei geschrieben,
+Falls ein Fehler auftritt, wird eine Zeile der Form ,,\verb;->Fehler;'' in die Datei geschrieben,
der eine beliebige Anzahl von Textzeilen folgen können, die den Fehler beschreiben.
Die Beschreibung endet immer mit dem Ende der Datei.
@@ -1452,8 +1323,6 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\newpage
\section{Zusammenfassung}
Das Programm WSPLGEN kommuniziert nur über die Kommandozeile und
@@ -1473,7 +1342,6 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\newpage
\section{Parameter}\label{sec:parameter}
@@ -1487,23 +1355,25 @@
WSP & WSP-Datei & Pfadangabe & - & keiner $<$erforderlich$>$\\\hline
LIN & Linien-Datei & Pfadangabe & - & keiner - $<$optional$>$ \\\hline
AUSGABE & Ausgabe-Datei & Pfadangabe & - & WSPLGEN.SHP \\\hline
-PROT & Protokoll-Datei & Pfadangabe & - & WSPLGEN.STA \\\hline
-FORT & Fortschritts-Datei & Pfadangabe & - & WSPLGEN.LOG \\\hline
\end{tabular}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
\section{Fehlermeldungen}\label{sec:fehlermeldungen}
+Werden Warnung vom Programm erzeugt, so wird das Programm fortgesetzt und am Ende als
+Rückgabewert der Wert der {\bf ersten} Warnung zurückgegeben.
+Die erste Ziffer gibt die Fehlergruppe an. Die zweite Ziffer gibt an,
+ob es sich um einen Fehler oder einen Warnung handelt. Die dritte und vierte Ziffer
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Kein Fehler}
Rückgabewert 0
-Fehlermeldung: Keine
+Fehler oder Warnung: Keine
Beschreibung: Es hat weder Fehler noch Warnungen gegeben.
@@ -1512,15 +1382,51 @@
\subsection{Fehlergruppe Parameterauswertung: 1xxx}
-\textbf{Rückgabewert: 1101}
+\textbf{Rückgabewert: 1201}
-Fehlermeldung: Unbekannter Parameter
+Fehler: Keine Parameter angegeben
-Beschreibung: Es wurde ein Parameter verwendet, der dem Programm WSPLGEN unbekannt ist.
+Beschreibung: Es wurde kein Parameter verwendet. Es müssen aber immer mindestens
+die Parameter -DGM für die DGM-Datei, -PRO für die Profillagen-Datei und -WSP für die Wasserstände
+angegeben werden.
\textbf{Rückgabewert: 1202}
+Fehler: Parameter -DGM nicht angegeben
+
+Beschreibung: Es wurde der Parameter -DGM nicht verwendet. Es müssen aber immer mindestens
+die Parameter -DGM für die DGM-Datei, -PRO für die Profillagen-Datei und -WSP für die Wasserstände
+angegeben werden.
+
+
+\textbf{Rückgabewert: 1203}
+
+Fehler: Parameter -PRO nicht angegeben
+
+Beschreibung: Es wurde der Parameter -PRO nicht verwendet. Es müssen aber immer mindestens
+die Parameter -DGM für die DGM-Datei, -PRO für die Profillagen-Datei und -WSP für die Wasserstände
+angegeben werden.
+
+
+\textbf{Rückgabewert: 1204}
+
+Fehler: Parameter -WSP nicht angegeben
+
+Beschreibung: Es wurde der Parameter -WSP nicht verwendet. Es müssen aber immer mindestens
+die Parameter -DGM für die DGM-Datei, -PRO für die Profillagen-Datei und -WSP für die Wasserstände
+angegeben werden.
+
+
+\textbf{Rückgabewert: 1205}
+
+Fehler: Unbekannter Parameter
+
+Beschreibung: Es wurde ein Parameter verwendet, der dem Programm WSPLGEN unbekannt ist.
+
+
+\textbf{Rückgabewert: 1106}
+
Warnung: Mehrfach verwendeter Parameter
Beschreibung: Es wurde ein Parameter mehrfach verwendet. Nur das erste Auftreten wird berücksichtigt.
@@ -1529,16 +1435,16 @@
als auch in der Parameterdatei vorkommt.
-\textbf{Rückgabewert: 1103}
+\textbf{Rückgabewert: 1207}
-Fehlermeldung: Argument fehlt
+Fehler: Argument fehlt
-Beschreibung: Es wurde kein Argument für einen Parameter angegeben. Das Gleichheitszeichen oder
+Beschreibung: Es wurde ein notwendiges Argument für einen Parameter nicht angegeben. Das Gleichheitszeichen oder
die Argumente nach dem Gleichheitszeichen fehlen. Möglicherweise wurden zuviele oder
-ungeschützte Leerzeichen verwendet (siehe Abschnit~\ref{subsec:param}).
+ungeschützte Leerzeichen verwendet (siehe Abschnit~\ref{sec:param}).
-\textbf{Rückgabewert: 1204}
+\textbf{Rückgabewert: 1108}
Warnung: Parameter DELTA ohne Argumente aufgerufen
@@ -1547,42 +1453,57 @@
überhaupt nicht angegeben zu werden. Das er doch gefunden wurde, könnte an einer falschen Aufrufsyntax liegen.
Es könnte das Gleichheitszeichen fehlen oder es könnten zu viele Leerzeichen eingefügt worden sein.
+\textbf{Rückgabewert: 1209}
-\textbf{Rückgabewert: 1205}
+Warnung: Parameter DELTA mit falscher anzahl von Argumenten aufgerufen
-Fehlermeldung: \verb;<Von>; ist größer als \verb;<Bis>;
+Beschreibung: Der Parameter DELTA darf mit verschieden vielen Parametern
+aufgerufen werden. Es müssen aber immer 2 Kommata verwendet werden,
+um die Argumente zu trennen, da sonst nicht entschieden werden kann,
+welche Argumente weggelasssen wurden.
+\textbf{Rückgabewert: 1210}
+
+Fehler: \verb;<Von>; ist größer als \verb;<Bis>;
+
Erklärung: Das Argument \verb;<Von>; ist größer als das Argument \verb;<Bis>;. Die Reihenfolge der Argumente
wurde wahrscheinlich nicht beachtet. Zuerst kommt \verb;<Von>;, dann \verb;<Bis>;, und dann \verb;<Diff>;.
-\textbf{Rückgabewert: 1206}
+\textbf{Rückgabewert: 1211}
-Fehlermeldung: \verb;<Diff>; ist kleiner als 0
+Fehler: \verb;<Diff>; ist kleiner als 0
Erklärung: Das Argument \verb;<Diff; muss immer größer oder gleich 0 sein.
-\textbf{Rückgabewert: 1207}
+\textbf{Rückgabewert: 1212}
-Fehlermeldung: \verb;<Diff>; ist gleich 0, aber \verb;<Von>; und \verb;<Bis>; sind verschieden.
+Fehler: \verb;<Diff>; ist gleich 0, aber \verb;<Von>; und \verb;<Bis>; sind verschieden.
Erklärung: Das Argument \verb;<Diff>; darf nur den Wert 0 haben, wenn \verb;<Von>; und \verb;<Bis>; gleich sind.
Sind \verb;<Von>; und \verb;<Bis>; verschieden, so wäre eine Abstufung in Schitten zu 0 Metern sinnlos.
-\textbf{Rückgabewert: 1208}
+\textbf{Rückgabewert: 1113}
Warnung: \verb;<Diff>; ist größer als die Differenz von \verb;<Bis>; und \verb;<Von>;
Erklärung: \verb;<Diff>; wird vom Programm ignoriert und nur eine Wassertiefenisolinie mit dem Wert \verb;<Von>; generiert.
+\textbf{Rückgabewert: 1214}
+
+Fehler: Ungültiges Argument für den Parameter \verb;-GEL;
+
+Erklärung: Der Parameter darf nur mit den Zeichenketten \verb;SPERRE; oder \verb;NOSPERRE; verwendet werden.
+
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Fehlergruppe Dateifehler: 2xxx}
-\textbf{Rückgabewert: 2101}
+\textbf{Rückgabewert: 2201}
Fehler: Eine Eingabedatei konnte nicht zum Lesen geöffnet werden.
@@ -1615,14 +1536,30 @@
\subsection{Fehlergruppe Datenfehler: 3xxx}
-\textbf{Rückgabewert: 3101}
+\textbf{Rückgabewert: 3201}
-Warnung: Eine Eingabedatei könnte nicht zum Lesen geöffnet werden.
+Warnung: Zwei Punkte des DGM liegen zu dicht zusammen.
-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.
+Erklärung: Zwei Punkte des DGM liegen zu dicht zusammen, so dass WSPLGEN sie
+nicht unterschieden kann. Die Z- Werte sind aber verschieden, so dass nicht
+entschieden werden kann, welche Höhe die korrekte ist. Es wird im Folgenden
+der erste Punkt benutzt.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Fehlergruppe Sonstige Fehler: 9xxx}
+
+\textbf{Rückgabewert: 9298}
+
+Fehler: Es ist ein abgefangener logischer Programmfehler aufgetreten. Der Anwender sollte
+sich mit den Programmierern in Verbindung setzen.
+
+
+\textbf{Rückgabewert: 9299}
+
+Fehler: Es ist ein nicht abgefangener logischer Programmfehler aufgetreten. Der Anwender sollte
+sich mit den Programmierern in Verbindung setzen.
+
Bemerkung: Die Liste der Fehler ist hiermit {\bf noch} nicht abschließend beschrieben.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
More information about the Wsplgen-commits
mailing list