Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex =================================================================== diff -u -r2561 -r2584 --- DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex (.../DataFormat.tex) (revision 2561) +++ DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DataFormat.tex (.../DataFormat.tex) (revision 2584) @@ -1,32 +1,40 @@ \chapter{Data format}\label{sec:USDataFormat} -All required and optional import data is placed in table OverviewDataUIAndEngine.xlsx, tab DAM\_input +Validation is done during three phases: import, editing in UI and for calculation. +\section{Validation during import} + +All required and optional import data is placed in table OverviewDataUIAndEngine.xlsx, 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 during import the default value is used, when a default is available. Default values are mentioned in OverviewDataUIAndEngine.xlsx Required data Data can be required when importing and/or required when calculating. In OverviewDataUIAndEngine.xlsx is described what data is required and when. Example: crosssection and dikering$\_$ are only required when using shapefiles (see column remark).\newline -If data is required for import and is missing, the exception handling is dependent of the kind of data, see \autoref{table:ExceptionHandlingReqData}. +If data is required for import and is missing or invalid, the exception handling is dependent of the kind of data, see \autoref{table:ExceptionHandlingReqData}. +Messages are given in the log window. + \begin{table}[H] \begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline \textbf{Parameter} & \textbf{Exception handling} \\ \hline -location$\_$id & All locations with missing location$\_$id are not imported and message is given. \\ \hline -surfaceline$\_$id & All locations with missing surfaceline$\_$id are not imported and message is given. \\ \hline -dikering$\_$id & Project is not imported and message is given. \\ \hline -segment$\_$id & Project is not imported and message is given. \\ \hline -calculation$\_$type & Project is not imported and message is given. \\ \hline -soilprofile$\_$id & Project is not imported and message is given. \\ \hline -top$\_$level & Project is not imported and message is given. \\ \hline -location$\_$scenario$\_$id & All locations with missing location$\_$scenario$\_$id are not imported and message is given. \\ \hline -crosssection & All locations with missing cross section are not imported and message is given. \\ \hline +location$\_$id in location.csv (or via shape) & All locations with missing location$\_$id are not imported and message is given. \\ \hline +location$\_$id in scenarios.csv (or via shape) & All scenarios with missing location$\_$id are not imported and message is given. \\ \hline +surfaceline in location.csv$\_$id & All locations with missing surfaceline$\_$id are not imported and message is given. \\ \hline +Profielnaam in surfacelines.csv$\_$id & All surfacelines with missing surfaceline$\_$id are not imported and message is given. \\ \hline +dikering$\_$id via shape & Project is not imported and message is given. \\ \hline +segment$\_$id in locations.csv or via shape & All locations with missing segment$\_$id are not imported and message is given. \\ \hline +segment$\_$id in segment.csv & All locations using segments with missing segment$\_$id are not imported and message is given. \\ \hline +calculation$\_$type in segments.csv & All locations using segments with missing calculation$\_$type are not imported and message is given. \\ \hline +soilprofile$\_$id in segments.csv & All locations using segments with missing soilprofile$\_$id are not imported and message is given. \\ \hline +top$\_$level in soilprofiles.csv& All locations linked (via segment) to soilprofiles with missing top$\_$level are not imported and message is given. \\ \hline +location$\_$scenario$\_$id & All scenarios with missing location$\_$scenario$\_$id are not imported and message is given. \\ \hline +characteristic points (required) & All locations with missing required characteristic points are not imported and message is given. \\ \hline +crosssection (via shape) & All locations with missing cross section are not imported and message is given. \\ \hline \end{tabular} \caption{Exception handling required data during import} \label{table:ExceptionHandlingReqData} @@ -35,10 +43,6 @@ In OverviewDataUIAndEngine.xls, tab DAM\_input also the optional data is listed. If these parameters are not present, no error or warning is given. When a default is available, this value is used, otherwise the parameters is NULL. If the parameter is required for calculation and the value is NULL and the kernel does not provide a default, an error message is given. -\section{Validation} -\ProgramName validates during the import of the data and during editing by user in the User interface. Minimal and maximum values are given in OverviewDataUIAndEngine.xlsx. -The data is also validated by the used kernels when calculations are started. - \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. @@ -86,7 +90,6 @@ & & Z$_{R}$ & m NAP & - & - \\ \hline \end{tabular} - If a required characteristic point is missing, (validation)message must be given: Characteristic point is missing.\newline Required characteristic points are: \begin{itemize} @@ -103,9 +106,16 @@ \begin{itemize} \item TrafficLoad (H and I in table) NL: Verkeersbelasting \item ShoulderOutside (E and F in table) NL: Buitenberm - \item ShoulderInside (K and L in table) NL: Binnberm + \item ShoulderInside (K and L in table) NL: Binnenberm \item Ditch (N,O,P and Q in table) NL: Sloot \end{itemize} Note: All sets are optional, but when one of the characteristic points is asigned, the others of the set must also be present. +\section{Validation during editing} +\ProgramName validates during the import of the data and during editing by user in the User interface. Minimal and maximum values are given in OverviewDataUIAndEngine.xlsx. +The data is also validated by the used kernels when calculations are started. + +\section{Validation for calculation} +\ProgramName validates during the import of the data and during editing by user in the User interface. +The data is also validated by the used kernels when calculations are started. Messages are given in the log window. Index: DamClients/DamUI/trunk/doc/DAM UI - Functional Design/DAM UI - Functional Design.pdf =================================================================== diff -u -r2561 -r2584 Binary files differ