Se agrega el primer draft del manual de usuario del Client.

[z.facultad/75.42/plaqui.git] / Client / doc / manual.lyx

diff --git a/Client/doc/manual.lyx b/Client/doc/manual.lyx
index 8431ed8b22e2e4182ed439cc54477e37c5629e27..be225b4a73372ffc1a03262b4a0b062462c042cb 100644 (file)
--- a/Client/doc/manual.lyx
+++ b/Client/doc/manual.lyx
@@ -1,23 +1,20 @@
 #LyX 1.3 created this file. For more info see http://www.lyx.org/
 \lyxformat 221
 #LyX 1.3 created this file. For more info see http://www.lyx.org/
 \lyxformat 221

-\textclass article
+\textclass book

 \language spanish
 \inputencoding auto
 \fontscheme palatino
 \graphics default
 \language spanish
 \inputencoding auto
 \fontscheme palatino
 \graphics default

-\paperfontsize 10
+\float_placement !htb
+\paperfontsize default

 \spacing single 
 \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
 \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
 \secnumdepth 3
 \tocdepth 3
 \paragraph_separation indent


@@ -25,85 +22,509 @@
 \quotes_language english
 \quotes_times 2
 \papercolumns 1
 \quotes_language english
 \quotes_times 2
 \papercolumns 1

-\papersides 1
+\papersides 2

 \paperpagestyle default
 \paperpagestyle default

-\bullet 1
-       0
-       24
-       -1
-\end_bullet

 
 \layout Title
 
 
 \layout Title
 

-PlaQui Client - Manual del Usuario
+PlaQui Client
+\newline 
+Manual de Usuario

 \layout Author
 
 \layout Author
 

-Versión Beta-Beta-Beta
-\layout Section
+Nicolás Dimov
+\newline 
+Leandro Lucarella
+\newline 
+Ricardo Markiewicz
+\layout Standard
+
+
+\begin_inset LatexCommand \tableofcontents{}
+
+\end_inset 

 
 

-Introducción
+
+\layout Chapter
+
+Introducción.

 \layout Standard
 
 \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 evolucion en el tiempo de la planta y
+ controlar los elemento que tengan alguna entrada.

 \layout Section
 
 \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 false
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Ventana-principal}
+
+\end_inset 
+
+Ventana principal de PlaQui Client
+\layout Standard
+
+
+\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
 
 \layout Standard
 

-La pantalla principal es la siguiente :
+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
 
 \layout Standard
 

+En este menú se encuentran todos los comandos generales de la aplicacion.
+\layout Description
+
+
+\begin_inset Graphics
+       filename conectar.png
+
+\end_inset 
+
+Conectar Abre una ventana de dialogo para conectarse al servidor.
+\layout Description
+
+
+\begin_inset Graphics
+       filename desconectar.png
+
+\end_inset 
+
+Desconectar Cierra la conexion con el servidor.
+\layout Description
+
+
+\begin_inset Graphics
+       filename finalizar_servidor.png
+
+\end_inset 
+
+Finalizar\SpecialChar ~
+Servidor Termina el servidor.
+ Debe tener cuidado al utilizar esta opcion porque si hay mas de un cliente
+ conectado, estos clientes se desconectaran.
+\layout Description
+

 
 \begin_inset Graphics
 
 \begin_inset Graphics

-       filename /home/share/programacion/FIUBA/TallerI/plaqui/Client/doc/img_main.eps
-       lyxscale 25
+       filename quit.png
+       lyxscale 80

        scale 80
        keepAspectRatio
 
 \end_inset 
 
        scale 80
        keepAspectRatio
 
 \end_inset 
 

+Salir 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 Description
+
+
+\begin_inset Graphics
+       filename properties.png
+
+\end_inset 
+
+Propiedades Abre una ventana de dialogo para modificar las propiedades de
+ la planta.
+\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 se encuentra debajo de la 
+\family sans 
+Barra de menú
+\family default 
+.
+ Tiene los comandos mas usados.
+\layout Standard
+
+
+\begin_inset Graphics
+       filename barra_herramientas.png
+
+\end_inset 
+
+
+\layout Standard
+
+En la parte inferior se encuentran herramientas adicionales útiles a la
+ hora de trabajar con la planta.
+\layout Description
+
+
+\begin_inset Graphics
+       filename conectar.png
+
+\end_inset 
+
+Conectar Se conecta a un servidor.
+\layout Description
+
+
+\begin_inset Graphics
+       filename simular.png
+
+\end_inset 
+
+Simular Comienza o reanuda la simulación del servidor.
+\layout Description
+
+
+\begin_inset Graphics
+       filename pausar.png
+
+\end_inset 
+
+Pausar Detiene momentáneamente la simulación del servidor.
+\layout Standard
+
+En el extremo derecho de la barra hay un indicador de conexión que informa
+ si el cliente esta conectado (verde) o desconectado (rojo).
+\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 informa sobre el estado de la conexión y las respuestas
+ del servidor.
+\layout Comment
+
+Actualizar cuando cambie.
+\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
+
+Iniciar la conexión.
+\layout Standard
+
+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
+
+\end_inset 
+
+ de la 
+\family sans 
+Barra de herramientas
+\family default 
+.
+ En ambos casos se abrirá una ventana de dialogo 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
+
+Si la conexión fue exitosa vera 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 información
+\family default 
+.
+\layout Subsection

 
 

+Terminar la conexión.

 \layout Standard
 
 \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.
+Para finalizar la conexión debe seleccionar la opcion 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
 
 \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.
+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 vera que la planta empieza a evolucionar en el tiempo.
+\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 vera que la planta se queda en el estado actual y no
+ cambia en el tiempo.
+\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
 
 \layout Subsection
 

-Ver una simulación
+Cambiar parámetros de simulación.

 \layout Standard
 
 \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 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 dialogo 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 cambiara
+ 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
 
 \layout Standard
 

-Si todo sale bien, luego de conectarse deberá aparecer la planta cargada
- en el área de visualización.
+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
 
 \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!)
+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 el.
+ 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 parentesis
+ 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
 
 \layout Subsection
 

-Envío de comandos
+Modificar estado de un elemento.

 \layout Standard
 
 \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 el.
+ 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
 \the_end