Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.pdf =================================================================== diff -u -r2269 -r2283 Binary files differ Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex =================================================================== diff -u --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex (revision 0) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex (revision 2283) @@ -0,0 +1,82 @@ +\chapter{Data format}\label{sec:USDataFormat} + +All required and optional import data is placed in table OverviewDataUIAndEngine.xls, tab DAM\_input + +\ProgramName can import data from csv files and shape files +The sequence of import is + 1. csv files (except scenarios.csv), overwritten by: + 2. shape files, overwritten by: + 3. scenario.csv + +\section{Presence} +If data is not present in the import, though required, \ProgramName uses the default value from OverviewDataUIAndEngine.xls, tab DAM\_input. + +\section{Validation} +In OverviewDataUIAndEngine.xls, tab DAM\_input the required data is listed. If not present, an error must be given. +In OverviewDataUIAndEngine.xls, tab DAM\_input the optional data is listed. If not present, no error or warning is given. + +The data is validated by the used kernels when calculations are started. DAM validates during the import of the data and during editing by user in the User interface. + +\subsection{Editing characteristic points}\label{sec:ValCharPoints} +When the characteristic points are edited by the user in the UI, they must be validated by rules in following table. Blue text validations are not implemented yet. + +\begin{tabular}{|p{35mm}|p{35mm}|p{\textwidth-72pt-105mm}|p{13mm}|p{11mm}|p{11mm}|} \hline +\textbf{Name EN} & \textbf{Name NL} & \textbf{Symbol} & \textbf{Unit} & \textbf{Min value} & \textbf{Max value} \\ \hline +\multirow{2}{35mm}{Surface level outside} & \multirow{2}{35mm}{Maaiveld buitenwaarts} & X$_{C}$ & m & - & - \\ \cline{3-6} + & & Z$_{C}$ & m NAP & - & - \\ \hline +\multirow{2}{35mm}{Dike toe at river} & \multirow{2}{35mm}{Teen Dijk buitenwaarts} & X$_{D}$ & m & $>$X$_{C}$ & $<$X$_{E}$ \\ \cline{3-6} + & & Z$_{D}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{C}$} & $<$Z$_{G}$ \\ \hline +\multirow{2}{35mm}{Shoulder top outside} & \multirow{2}{35mm}{Kruin buitenberm} & X$_{E}$ & m & $>$X$_{D}$ & $<$X$_{F}$ \\ \cline{3-6} + & & Z$_{E}$ & m NAP &\textcolor[rgb]{0,0,1}{ $>$Z$_{D}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{F}$} \\ \hline +\multirow{2}{35mm}{Shoulder base outside} & \multirow{2}{35mm}{Insteek buitenberm} & X$_{F}$ & m & $>$X$_{E}$ & $<$X$_{G}$ \\ \cline{3-6} + & & Z$_{F}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{E}$ }& \textcolor[rgb]{0,0,1}{$<$Z$_{G}$ }\\ \hline +\multirow{2}{35mm}{Dike top at river} & \multirow{2}{35mm}{Kruin buitentalud} & X$_{G}$ & m & $>$X$_{F}$ & $<$X$_{H}$ \\ \cline{3-6} + & & Z$_{G}$ & m NAP & $>$Z$_{D}$ & - \\ \hline +\multirow{2}{35mm}{Traffic load outside} & \multirow{2}{35mm}{Verkeersbelasting buitenwaarts} & X$_{H}$ & m & \textcolor[rgb]{0,0,1}{$>$X$_{C}$ }& \textcolor[rgb]{0,0,1}{$<$X$_{I}$} \\ \cline{3-6} + & & Z$_{H}$ & m NAP &\textcolor[rgb]{0,0,1}{$>$Z$_{G}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{I}$} \\ \hline +\multirow{2}{35mm}{Traffic load inside} & \multirow{2}{35mm}{Verkeersbelasting binnenwaarts} & X$_{I}$ & m & \textcolor[rgb]{0,0,1}{$>$X$_{H}$ }& \textcolor[rgb]{0,0,1}{$<$X$_{S}$} \\ \cline{3-6} + & & Z$_{I}$ & m NAP &\textcolor[rgb]{0,0,1}{$>$Z$_{H}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{J}$} \\ \hline +\multirow{2}{35mm}{Dike top at polder} & \multirow{2}{35mm}{Kruin binnentalud} & X$_{J}$ & m & $>$X$_{I}$ & $<$X$_{K}$ \\ \cline{3-6} + & & Z$_{J}$ & m NAP & $>$Z$_{M}$ & -\\ \hline +\multirow{2}{35mm}{Shoulder base inside} & \multirow{2}{35mm}{Insteek binnenberm} & X$_{K}$ & m & $>$X$_{J}$ & $<$X$_{L}$ \\ \cline{3-6} + & & Z$_{K}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{J}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{L}$} \\ \hline +\multirow{2}{35mm}{Shoulder top inside} & \multirow{2}{35mm}{Kruin binnenberm} & X$_{L}$ & m & $>$X$_{K}$ & $<$X$_{M}$ \\ \cline{3-6} + & & Z$_{L}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{K}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{M}$ }\\ \hline +\multirow{2}{35mm}{Dike toe at polder} & \multirow{2}{35mm}{Teen dijk binnenwaarts} & X$_{M}$ & m & $>$X$_{L}$ & $<$X$_{N}$ \\ \cline{3-6} + & & Z$_{M}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{L}$} & $<$Z$_{J}$ \\ \hline +\multirow{2}{35mm}{Ditch dike side} & \multirow{2}{35mm}{Insteek sloot dijkzijde} & X$_{N}$ & m & $>$X$_{M}$ & $<$X$_{O}$ \\ \cline{3-6} + & & Z$_{N}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{M}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{O}$} \\ \hline +\multirow{2}{35mm}{Bottom ditch dike side} & \multirow{2}{35mm}{Slootbodem dijkzijde} & X$_{O}$ & m & $>$X$_{N}$ & $<$X$_{P}$ \\ \cline{3-6} + & & Z$_{O}$ & m NAP & $>$Z$_{N}$ & $<$Z$_{P}$ \\ \hline +\multirow{2}{35mm}{Bottom ditch polder side} & \multirow{2}{35mm}{Slootbodem polderzijde} & X$_{P}$ & m & $>$X$_{O}$ & $<$X$_{Q}$ \\ \cline{3-6} + & & Z$_{P}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{O}$} &\textcolor[rgb]{0,0,1}{ $<$Z$_{Q}$} \\ \hline +\multirow{2}{35mm}{Ditch polder side} & \multirow{2}{35mm}{Insteek sloot polderzijde} & X$_{Q}$ & m & $>$X$_{P}$ & $<$X$_{R}$ \\ \cline{3-6} + & & Z$_{Q}$ & m NAP & \textcolor[rgb]{0,0,1}{$>$Z$_{P}$} & \textcolor[rgb]{0,0,1}{$<$Z$_{R}$ }\\ \hline +\multirow{2}{35mm}{Surface level inside} & \multirow{2}{35mm}{Maaiveld binnenwaarts} & X$_{R}$ & m & - & - \\ \cline{3-6} + & & Z$_{R}$ & m NAP & - & - \\ \hline +\end{tabular} + +%Sets of characteristic points +%\ProgramName must check if the set(s) of characteristic points are complete. +%The name sets are:\newline +% +%\begin{itemize} + %\item Traffic load (H and I in table) + %\item Shoulder outside (E and F in table) + %\item Shoulder inside (K and L in table) + %\item Ditch (O,P,Q and R in table) +%\end{itemize} +% +%If one of the set is missing, (validation)message must be given: Characteristic points set is not complete. +If an required characteristic point is missing, (validation)message must be given: Characteristic point is missing. + +Required characteristic points are: +\begin{itemize} + \item Surface level outside + \item Dike toe at river + \item Dike top at river + \item Dike top at polder + \item Dike toe at polder + \item Surface level inside +\end{itemize} + \ No newline at end of file