Merge pull request #252 from hpuhr/devel

Devel

Author: hpuhr

CMakeLists.txt

@@ -28,6 +28,7 @@ find_package(Qt5Widgets)
 find_package(Qt5Core)
 find_package(Qt5OpenGL)
 find_package(Qt5Charts)
+find_package(Qt5Test)
 
 message("Qt Widgets version: ${Qt5Widgets_VERSION}")
 
@@ -119,6 +120,7 @@ include_directories (
     ${Qt5Widgets_INCLUDE_DIRS}
     ${Qt5OpenGL_INCLUDE_DIRS}
     ${Qt5Charts_INCLUDE_DIRS}
+    ${Qt5Test_INCLUDE_DIRS}
     ${Boost_INCLUDE_DIRS}
     ${SQLITE3_INCLUDE_DIR}
     ${LOG4CPP_INCLUDE_DIR}
@@ -140,6 +142,7 @@ target_link_libraries ( compass
     Qt5::Core
     Qt5::OpenGL
     Qt5::Charts
+    Qt5::Test
     ${jASTERIX_LIBRARIES}
     ${Boost_LIBRARIES}
     ${LOG4CPP_LIBRARIES}

doc/user_manual/filters/figures/ui_filters.png

@@ -54,6 +54,19 @@ \section{OSG View}
 
 When clicking the \includegraphics[width=0.5cm,frame]{../../data/icons/right.png} button, the displayed time window will again follow the most recent time. This can also be achieved by moving the scrollbar to the most right position.
 
+\subsection{Online/Offline Display}
+
+To indicite if the displayed data is the currently most recent or from a previous point in time, the OSGView can display colored text (by default "Online" or "Offline"). After creation of the OSView and closing the application, this feature can be enabled using the configuration options listed in \nameref{sec:live_online_offline}.
+
+\begin{figure}[H]
+    \hspace*{-2.5cm}
+    \includegraphics[width=19cm,frame]{figures/osgview_offline_status.png}
+  \caption{OSG View Overload Message}
+\end{figure} 
+
+The online state text is shown if the application is in Live:Running mode and the most recent data is displayed. In all other states (other application mode or previous time window displayed) the offline state text is displayed.
+
+
 \section{Overload Detection}
 
 The ASTERIX Import task as well as the OSGView can detect and handle overload situations. If the real-time processing is not possible with the used workstation, display latency builds up - resulting in ASTERIX data queuing up. \\
@@ -66,13 +79,19 @@ \section{Overload Detection}
   \caption{OSG View Overload Message}
 \end{figure} 
 
-If the latency exceeds 11 seconds, ASTERIX data is skipped - therefore not decoded, added to the database, or displayed.
+If the latency exceeds 60 seconds, ASTERIX data is skipped - therefore not decoded, added to the database, or displayed.
+
+\section{Auto-Resume From Live:Paused}
+
+If the application is switched to the Live:Paused mode, an automatic resume function is activated to ensure that the application is not inadvertently kept in this mode for too long. In its default settings, every 60 minutes a dialog is opened which allows user interaction to stay in the Live:Paused mode. If no action is taken, after 1 minute an automatic resume in the Live:Running mode is performed. \\
+
+This feature can be configured using the configuration options listed in \nameref{sec:live_paused_resume}.
 
 \section{Long-Term Running}
 
 The application is optimized for long-term runnning, and can be run continuously. During Live mode, data older than 1 hour is removed from the database. \\
 
-In this use case, usage of a rotating log file (as described in \nameref{sec:appendix_logging_rotate}) is recommened.
+In this use case, usage of a rotating log file (as described in \nameref{sec:appendix_logging_rotate}) is recommended.
 
 \section{Configuration Options of Interest}
 
@@ -97,6 +116,26 @@ \subsection{Hide Evaluation and View Points}
 ...        
 \end{lstlisting}
 
+\subsection{Disable Adding/Removing Views}
+
+In the file 'compass.json' the following parameters can be set:
+
+\begin{lstlisting}
+...
+        "disable_add_remove_views": false,
+...        
+\end{lstlisting}
+
+\subsection{Disable Switching Live to Offline Mode}
+
+In the file 'compass.json' the following parameters can be set:
+
+\begin{lstlisting}
+...
+        "disable_live_to_offline_switch": false,
+...        
+\end{lstlisting}
+
 \subsection{Change Cache or Database Time Duration}
 
 Per default, the RAM cache is limited to 5 minutes, while the database content is limited to 60 minutes. To change these durations (if workstation performance allows for it), the following values can be set in the file 'db\_content.json' (values in minutes):
@@ -108,8 +147,44 @@ \subsection{Change Cache or Database Time Duration}
 ...        
 \end{lstlisting}
 
+\subsection{OSGView Online/Offline Display}
+\label{sec:live_online_offline}
+
+In the 'views.json' configuration file, in the respective OSGView section, the following parameters can be set:
+
+\begin{lstlisting}
+...
+        "offline_text": "Offline",
+        "offline_text_color_str": "#FF0000",
+        "online_text": "Online",
+        "online_text_color_str": "#00FF00",
+        "status_message_font_size": 24,
+        "use_online_messages": false,        
+...        
+\end{lstlisting}
+
+The display of the text can be enabled using the 'use\_online\_messages' flag, the other parameters configure text size, text captions and text coloring.
 
+\subsection{OSGView Disable Rotate}
 
+In the file 'compass.json' the following parameters can be set:
 
+\begin{lstlisting}
+...
+        "disable_osgview_rotate": false,
+...        
+\end{lstlisting}
+
+\subsection{Auto-Resume From Live:Paused}
+\label{sec:live_paused_resume}
+
+In the file 'compass.json' the following values can be adapted to change how often the auto-resume question is asked, and the dialog wait time until the auto-resume is performed:
+
+\begin{lstlisting}
+...
+        "auto_live_running_resume_ask_time": 60,
+        "auto_live_running_resume_ask_wait_time": 1,
+...        
+\end{lstlisting}
 
 

doc/user_manual/live/figures/osgview_offline_status.png

@@ -10,7 +10,7 @@ \subsection{Labels Tab}
 In the 'Labels' tab, several elements exist:
 
 \begin{itemize}
- \item \includegraphics[width=0.5cm,frame]{../../data/icons/edit.png} button: Edit label contents
+ \item \includegraphics[width=0.5cm,frame]{../../data/icons/edit.png} button: Label menu 
  \item Auto Label Checkbox: Toggles auto-label feature
  \item Level of Detail: What level of detail should be used for labels
  \item Data Sources: Selects which data sources to label and label direction
@@ -20,9 +20,19 @@ \subsection{Labels Tab}
 
 When the auto-label feature is active and one or more data sources are selected for labeling, automatic labels are generated in the OSG View according to the content and label filter settings. \\
 
+\subsubsection{Label Menu}
+
+This menu allows showing all nor no data source labels, or to edit label contents.
+
+\begin{figure}[H]
+   \center
+    \includegraphics[width=3cm,frame]{figures/osgview_label_tab_menu.png}
+  \caption{OSG View Label Tab Menu}
+\end{figure}
+
 \subsubsection{Label Contents}
 
-When clicking the 'Edit Label Contents' button \includegraphics[width=0.5cm,frame]{../../data/icons/edit.png}, the label content specific to a DBContent can be selected. \\
+Using the 'Label menu' button \includegraphics[width=0.5cm,frame]{../../data/icons/edit.png}, the label content specific to a DBContent can be edited. \\
 
 The label contents are organized in a 3x3 matrix, the contents if the first 2 rows and columns are fixed while row 3 and column 3 can be edited. 
 
@@ -63,7 +73,15 @@ \subsubsection{Label Contents}
  \item Row 3, column 3: Time of Day
  \end{itemize} 
 \end{itemize} 
+\ \\
+
+Please note that the Mode A and the Mode C code are automatically displayed using the respective garbled/valid flag information as suffixes:
 
+\begin{itemize}
+ \item (I)nvalid
+ \item (G)arbled
+ \item (S)moothed
+\end{itemize} 
 
 \subsubsection{Automatic Labeling}