X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/blobdiff_plain/24b6a7f8209541d589b0bdeb38493a67b94d1551..9cb06c6560f458cc3a8c1d1b2f354e54d2458dd0:/Client/doc/manual.lyx

diff --git a/Client/doc/manual.lyx b/Client/doc/manual.lyx
index 8431ed8..93328f4 100644
--- a/Client/doc/manual.lyx
+++ b/Client/doc/manual.lyx
@@ -1,23 +1,31 @@
 #LyX 1.3 created this file. For more info see http://www.lyx.org/
 \lyxformat 221
-\textclass article
+\textclass book
+\begin_preamble
+\usepackage{graphicx}
+\newcommand{\myLogo}[2]{%
+\setlength{\unitlength}{1cm}
+\begin{picture}(0,0)
+\put(-8,+8.5){#1}% the logo for the left side
+%\put(8,+8.5){#1}% the logo for the right side
+\put(-7,9){\parbox[b]{5cm}{\Large \centering #2}}
+%\put(3,9){\parbox[b]{5cm}{\Large \centering #2}}% text for the rightside
+\end{picture}}
+\end_preamble
 \language spanish
 \inputencoding auto
 \fontscheme palatino
 \graphics default
-\paperfontsize 10
+\float_placement !htb
+\paperfontsize default
 \spacing single 
-\papersize Default
-\paperpackage a4
-\use_geometry 1
+\papersize a4paper
+\paperpackage widemarginsa4
+\use_geometry 0
 \use_amsmath 0
 \use_natbib 0
 \use_numerical_citations 0
 \paperorientation portrait
-\leftmargin 2cm
-\topmargin 1cm
-\rightmargin 1cm
-\bottommargin 2cm
 \secnumdepth 3
 \tocdepth 3
 \paragraph_separation indent
@@ -25,85 +33,745 @@
 \quotes_language english
 \quotes_times 2
 \papercolumns 1
-\papersides 1
-\paperpagestyle default
-\bullet 1
-	0
-	24
-	-1
-\end_bullet
+\papersides 2
+\paperpagestyle headings
 
 \layout Title
 
-PlaQui Client - Manual del Usuario
-\layout Author
+PlaQui Client
+\newline 
+Manual de Usuario
+\newline 
+\SpecialChar ~
+
+\newline 
+ 
+\begin_inset Graphics
+	filename ../pixmaps/logo.png
+	width 8cm
+
+\end_inset 
+
+
+\layout Date
+
+Versión 1.0
+\layout Standard
 
-Versión Beta-Beta-Beta
-\layout Section
 
-Introducción
+\begin_inset LatexCommand \tableofcontents{}
+
+\end_inset 
+
+
+\layout Chapter
+
+Introducción.
 \layout Standard
 
-TODO ///
+PlaQui es un conjunto de aplicaciones para diseño, simulación y control
+ de plantas químicas.
+\layout Standard
+
+PlaQui Client es la aplicación para controlar y visualizar una planta química.
+ Con este programa se puede ver la evolución en el tiempo de la planta y
+ controlar los elemento que tengan alguna entrada.
 \layout Section
 
-Interfaz de Usuario
+Abrir la aplicación.
+\layout Standard
+
+Para abrir la aplicación basta con ejecutarla desde la línea de comandos.
+ Escriba 
+\family typewriter 
+plaqui-client
+\family default 
+ y presione 
+\family typewriter 
+Enter
+\family default 
+.
+\layout Subsection
+
+Pantalla inicial.
+\layout Standard
+
+Una vez abierta la aplicación aparecerá la ventana principal que se puede
+ ver en la figura 
+\begin_inset LatexCommand \vref{cap:Ventana-principal}
+
+\end_inset 
+
+.
+\layout Standard
+
+
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Ventana-principal}
+
+\end_inset 
+
+Ventana principal de PlaQui Client.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+	filename principal.png
+	lyxscale 50
+	width 14.7cm
+	keepAspectRatio
+
+\end_inset 
+
+
+\end_inset 
+
+
+\layout Standard
+
+La ventana contiene los siguientes elementos:
+\layout Subsubsection
+
+Barra de menú.
+\layout Standard
+
+En la barra de menú se encuentra en la parte superior de la ventana y en
+ ella están todas los comandos para trabajar con el programa.
+\layout Paragraph
+
+Menú 
+\family sans 
+Archivo
+\family default 
+.
+\layout Standard
+
+En este menú se encuentran todos los comandos generales de la aplicación.
+\layout Standard
+
+
+\begin_inset Graphics
+	filename conectar_m.png
+	lyxscale 80
+	scale 50
+
+\end_inset 
+
+
+\family sans 
+ Conectar
+\layout Standard
+
+Abre una ventana de diálogo para conectarse al servidor.
+\layout Standard
+
+
+\begin_inset Graphics
+	filename desconectar_m.png
+	lyxscale 80
+	scale 50
+
+\end_inset 
+
+
+\family sans 
+ Desconectar
 \layout Standard
 
-La pantalla principal es la siguiente :
+Cierra la conexión con el servidor.
 \layout Standard
 
 
 \begin_inset Graphics
-	filename /home/share/programacion/FIUBA/TallerI/plaqui/Client/doc/img_main.eps
-	lyxscale 25
-	scale 80
+	filename quit.png
+	lyxscale 70
+	scale 40
 	keepAspectRatio
 
 \end_inset 
 
 
+\family sans 
+ Salir
+\layout Standard
+
+Sale del programa.
+\layout Paragraph
+
+Menú 
+\family sans 
+Ver
+\family default 
+.
+\layout Standard
+
+En este menú se encuentran los comandos para modificar la forma de visualizar
+ la planta.
+\layout Standard
+
+
+\begin_inset Graphics
+	filename properties.png
+	lyxscale 70
+	scale 40
+
+\end_inset 
+
+
+\family sans 
+ Propiedades
+\layout Standard
+
+Abre una ventana de diálogo para modificar las propiedades de la planta.
+\layout Paragraph
+
+Menú 
+\family sans 
+Ver
+\family default 
+.
+\layout Standard
+
+En este menú se encuentran los comandos para controlar el servidor.
+\layout Standard
+
+
+\begin_inset Graphics
+	filename detener_servidor.png
+	lyxscale 70
+	scale 40
+
+\end_inset 
+
+
+\family sans 
+ Detener Servidor
+\layout Standard
+
+Detiene el servidor.
+ Debe tener cuidado al utilizar esta opcion porque cierra el servidor inmediatam
+ente, si hay otros clientes serán desconectados.
+\layout Paragraph
+
+Menú 
+\family sans 
+Ayuda
+\family default 
+.
+\layout Standard
+
+En este menú se encuentran los comandos para obtener ayuda.
+\layout Description
+
+Acerca Obtiene información acerca de la aplicación.
+\layout Subsubsection
+
+Barra de herramientas.
+\layout Standard
+
+La barra de herramientas
+\begin_inset Float figure
+wide false
+collapsed false
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Barra-de-herramientas.}
+
+\end_inset 
+
+Barra de herramientas.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+	filename barra_herramientas.png
+	width 11cm
+
+\end_inset 
+
+
+\end_inset 
+
+ se encuentra debajo de la 
+\family sans 
+Barra de menú
+\family default 
+ (ver figura 
+\begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
+
+\end_inset 
+
+).
+ Tiene los comandos mas frecuentemente utilizados.
+\layout Standard
+
+
+\begin_inset Graphics
+	filename conectar.png
+	lyxscale 40
+	scale 20
+
+\end_inset 
+
+
+\family sans 
+ Conectar
+\layout Standard
+
+Se conecta a un servidor.
+\layout Standard
+
+
+\begin_inset Graphics
+	filename simular.png
+	lyxscale 40
+	scale 20
+
+\end_inset 
+
+
+\family sans 
+ Simular
 \layout Standard
 
-En el centro se encuentra el área de visualización que es donde aparece
- la planta que es simulada en el servidor.
- En el recuadro de la derecha se encuentran, arriba el cuadro de propiedades
- del item actual y debajo el campo de texto del LOG del cliente.
+Comienza o reanuda la simulación del servidor.
 \layout Standard
 
-Para saber si se está conectado se dispone de un indicador gráfico en el
- borde superior derecho, que al estar conectado se encuentra en verde y
- al estar desconectado está en rojo.
+
+\begin_inset Graphics
+	filename pausar.png
+	lyxscale 40
+	scale 20
+
+\end_inset 
+
+
+\family sans 
+ Pausar
+\layout Standard
+
+Detiene momentáneamente la simulación del servidor.
+\layout Standard
+
+En el extremo derecho de la barra hay un 
+\family sans 
+Indicador de conexión
+\family default 
+ que informa si el cliente esta conectado 
+\begin_inset Graphics
+	filename conectar_m.png
+	lyxscale 80
+	scale 50
+
+\end_inset 
+
+ o desconectado 
+\begin_inset Graphics
+	filename desconectar_m.png
+	lyxscale 80
+	scale 50
+
+\end_inset 
+
+.
+\layout Subsubsection
+
+Barra de información.
+\layout Standard
+
+Es la barra que se encuentra a la derecha de la ventana principal y esta
+ dividida en dos.
+ En la parte superior se indica el estado del elemento seleccionado actualmente,
+ en la parte inferior se encuentra una animación que indica si se están
+ recibiendo datos del servidor.
+ Si la animación esta detenida pueden haber pasado 3 cosas:
+\layout Itemize
+
+Pudo haberse perdido la conexión con el servidor.
+ En este caso el 
+\family sans 
+Indicador de conexión
+\family default 
+ estará en rojo.
+\layout Itemize
+
+La simulación puede estar pausada.
+ Pruebe presionando el icono para 
+\family sans 
+Simular
+\family default 
+.
+\layout Itemize
+
+Puede haber un problema de red, por el cual no está llegando el estado de
+ la planta.
+\layout Subsubsection
+
+Barra de estado.
+\layout Standard
+
+Es el área de texto que se encuentra en la parte inferior de la ventana
+ principal.
+ Informa sobre el estado de la conexión y las respuestas del servidor.
+\layout Subsubsection
+
+Área de visualización.
+\layout Standard
+
+Es el espacio central, en el se muestra la planta que se esta controlando.
+\layout Section
+
+Iniciar y terminar una conexión.
 \layout Subsection
 
-Ver una simulación
+Iniciar la conexión.
 \layout Standard
 
-Para iniciar una simulacion se debe ir al Menu->Conectar o acceder a travéz
- del botón en la barra del programa.
- Aparecerá un diálogo donde debe ingresar el IP o nombre del Host donde
- se encuentra corriendo el servidor y el puerto por el cual escucha.
+Para inicial la conexión con un servidor hay dos formas: desde el menú 
+\family sans 
+Archivo\SpecialChar \menuseparator
+Conectar
+\family default 
+ o presionando sobre el icono 
+\begin_inset Graphics
+	filename conectar.png
+	lyxscale 40
+	scale 20
+
+\end_inset 
+
+ de la 
+\family sans 
+Barra de herramientas
+\family default 
+.
+ En ambos casos se abrirá una ventana de diálogo
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Ventana-de-diálogo}
+
+\end_inset 
+
+Ventana de diálogo para conectarse al servidor.
 \layout Standard
+\align center 
+
+\begin_inset Graphics
+	filename dialogo_conectar.png
+	width 5cm
+
+\end_inset 
+
+
+\end_inset 
+
+ (figura 
+\begin_inset LatexCommand \vref{cap:Ventana-de-diálogo}
 
-Si todo sale bien, luego de conectarse deberá aparecer la planta cargada
- en el área de visualización.
+\end_inset 
+
+) en la que puede seleccionar el 
+\emph on 
+host
+\emph default 
+ y el puerto del servidor al cual conectarse.
+ Una vez ingresados los datos, presione 
+\family sans 
+Aceptar
+\family default 
+.
+ La planta servida aparecerá en el 
+\family sans 
+Área de visualización
+\family default 
+.
 \layout Standard
 
-Haciendo click con el mouse sobre los diferentes items en la pantalla, se
- podrá ver en el cuadro de propiedades el estado actual dependiendo del
- item que sea.
- Si el item es una bomba o una exclusa, al apretar el boton On/Off el objeto
- cambiará de estado al opuesto al actual.
- Si el elemento no soporta este metodo, el boton no hará nada (TODO : esto
- se va a cambiar para la entrega final!)
+Si la conexión fue exitosa verá que el indicador de conexión de la 
+\family sans 
+Barra de herramientas
+\family default 
+ se pondrá verde y aparecerá un mensaje en la 
+\family sans 
+Barra de estado
+\family default 
+.
+\layout Subsection
+
+Terminar la conexión.
+\layout Standard
+
+Para finalizar la conexión debe seleccionar la opción del menú 
+\family sans 
+Archivo\SpecialChar \menuseparator
+Desconectar
+\family default 
+.
+\layout Section
+
+Empezar, pausar y cambiar parámetros de la simulación.
+\layout Subsection
+
+
+\begin_inset LatexCommand \label{sub:Empezar-la-simulacion.}
+
+\end_inset 
+
+Empezar la simulación.
+\layout Standard
+
+Para empezar la simulación debe hacer click sobre el icono 
+\family sans 
+Simular
+\family default 
+ de la 
+\family sans 
+Barra de Herramientas
+\family default 
+.
+ A partir de ahora verá que la planta empieza a evolucionar en el tiempo.
+ La animación
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Simulación-en-curso.}
+
+\end_inset 
+
+Simulación en curso.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+	filename simulando.png
+	lyxscale 50
+	width 14.7cm
+
+\end_inset 
+
+
+\end_inset 
+
+ de la 
+\family sans 
+Barra de Información
+\family default 
+ le servirá para saber que la planta está en funcionamiento.
+ En la figura 
+\begin_inset LatexCommand \ref{cap:Simulación-en-curso.}
+
+\end_inset 
+
+ puede ver un ejemplo.
+\layout Subsection
+
+Pausar la simulación.
+\layout Standard
+
+Para pausar la simulación debe hacer click sobre el icono 
+\family sans 
+Pausar
+\family default 
+ de la 
+\family sans 
+Barra de Herramientas
+\family default 
+.
+ A partir de ahora verá que la planta se queda en el estado actual y no
+ cambia en el tiempo
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Simulación-en-pausa.}
+
+\end_inset 
+
+Simulación en pausa.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+	filename conectado_pausa.png
+	lyxscale 50
+	width 14.7cm
+
+\end_inset 
+
+
+\end_inset 
+
+ como se ve en la figura 
+\begin_inset LatexCommand \ref{cap:Simulación-en-pausa.}
+
+\end_inset 
+
+.
+ La animación de la 
+\family sans 
+Barra de Información
+\family default 
+ se detendrá también.
+\layout Subsection
+
+Reanudar la simulación.
+\layout Standard
+
+Para reanudar la simulación basta con seguir los pasos de 
+\begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
+
+\end_inset 
+
+.
+\layout Subsection
+
+Cambiar parámetros de simulación.
+\layout Standard
+
+Para cambiar los parámetros de la simulación debe seleccionar la opcion
+ del menú 
+\family sans 
+Ver\SpecialChar \menuseparator
+Propiedades
+\family default 
+.
+ Se abrirá una ventana de diálogo en donde puede elegir la velocidad de
+ la simulación (o tiempo de refresco).
+ Puede ingresar en el campo la cantidad de veces por segundo que cambiará
+ de estado la planta y luego presionar 
+\family sans 
+Aceptar
+\family default 
+ para que el servidor tome los cambios.
+\layout Section
+
+Salir del programa.
+\layout Standard
+
+Para salir del programa puede presionar sobre la cruz que generalmente se
+ encuentra en la esquina superior derecha de la ventana principal (esto
+ depende de su manejador de ventanas) o desde el menú 
+\family sans 
+Archivo\SpecialChar \menuseparator
+Salir
+\family default 
+.
+\layout Chapter
+
+Controlar una planta.
+\layout Standard
+
+El proceso de control de una planta es simple porque el estado se ve en
+ tiempo real en el 
+\family sans 
+Área de visualización
+\family default 
+.
+ Para poder observar cada elemento detenidamente sin sufrir cambios es posible
+ detener la planta por un tiempo y después volver a reanudarla.
+\layout Section
+
+Ver el estado de la planta.
+\layout Standard
+
+El estado de la planta puede verse en forma global ya que sobre cada elemento
+ se ve el color del liquido que fluye, si por ese elemento hay flujo en
+ ese instante.
+ Puede verse también a simple vista el estado de los circuitos lógicos,
+ cuyos cables son coloreados según su estado.
+ Los cables azules representan un estado bajo (0 o falso) y los cables rojos
+ un estado alto (1 o verdadero).
+\layout Subsection
+
+Ver estado detallado de un elemento.
+\layout Standard
+
+Para ver el estado detallado de un elemento primero debe seleccionarlo en
+ el 
+\family sans 
+Área de trabajo
+\family default 
+ haciendo click sobre él.
+ En la parte de 
+\family sans 
+Propiedades
+\family default 
+ de la 
+\family sans 
+Barra de información
+\family default 
+ aparecerán todos detalles de dicho elemento.
+\layout Subsubsection
+
+Propiedades.
+\layout Standard
+
+Las propiedades de los elementos mostradas son las siguientes (entre paréntesis
+ se indica que elementos tienen dicha propiedad):
+\layout Description
+
+Nombre Nombre del elemento (todos).
+\layout Description
+
+Color Color del flujo que esta pasando actualmente por el elemento (todos).
+\layout Description
+
+Flujo\SpecialChar ~
+Actual Indica el flujo que esta pasando actualmente por el elemento
+ (todos menos tanque).
+\layout Description
+
+Estado Estado del elemento: Abierto o Cerrado (exclusa), Encendida o Apagada
+ (bomba)
+\layout Description
+
+Capacidad Capacidad de almacenamiento de fluidos del elemento (tanque).
+\layout Description
+
+Liquido Cantidad de flujo almacenado actualmente en el elemento (tanque).
 \layout Subsection
 
-Envío de comandos
+Modificar estado de un elemento.
 \layout Standard
 
-En la parte inferior se encuentra una interfaz temporal para enviar comando
- al servidor.
- Consulte la documentacion del servidor o el codigo fuente para saber que
- comandos estan disponible.
- TODO : esto vuela para la entrega final
+Para modificar el estado un elemento primero debe seleccionarlo en el 
+\family sans 
+Área de trabajo
+\family default 
+ haciendo click sobre él.
+ En la parte inferior de 
+\family sans 
+Propiedades
+\family default 
+ de la 
+\family sans 
+Barra de información
+\family default 
+ hay un botón 
+\family sans 
+On/Off
+\family default 
+ que puede utilizarse para encender o apagar una bomba y abrir o cerrar
+ una exclusa.
+ Solo se puede cambiar el estado de bombas y exclusas.
 \the_end