From a55be4baabc452fb5ba393ebd5f3a219eb8e61e9 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Mon, 1 Dec 2003 23:13:08 +0000 Subject: [PATCH] Manual del Constructor finiquitado. --- Constructor/doc/manual.lyx | 648 +++++++++++++++++++++++++++++-------- TODO | 7 +- 2 files changed, 508 insertions(+), 147 deletions(-) diff --git a/Constructor/doc/manual.lyx b/Constructor/doc/manual.lyx index 076117e..5e9adc5 100644 --- a/Constructor/doc/manual.lyx +++ b/Constructor/doc/manual.lyx @@ -37,6 +37,9 @@ Nicol Leandro Lucarella \newline Ricardo Markiewicz +\layout Date + +Versión 1.0 \layout Standard @@ -81,7 +84,7 @@ Pantalla inicial. Una vez abierta la aplicación aparecerá la ventana principal \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -132,45 +135,73 @@ Archivo En este menú se encuentran todos los comandos para manejar archivos y salir del programa. -\layout Description +\layout Standard \begin_inset Graphics filename new.png + lyxscale 70 + scale 40 rotateOrigin center \end_inset -Nuevo Empieza a construir una planta nueva. + +\family sans +Nuevo +\layout Standard + +Empieza a construir una planta nueva. La planta con la que estaba trabajando actualmente será descartada. -\layout Description +\layout Standard \begin_inset Graphics filename open.png + lyxscale 70 + scale 40 \end_inset -Abrir Abre una planta nueva. + +\family sans +Abrir +\layout Standard + +Abre una planta nueva. La planta con la que estaba trabajando actualmente será descartada. -\layout Description +\layout Standard \begin_inset Graphics filename save.png + lyxscale 70 + scale 40 \end_inset -Guardar Guarda la planta actual. -\layout Description + +\family sans +Guardar Como... +\layout Standard + +Guarda la planta actual preguntando el nombre del archivo donde grabarla. +\layout Standard \begin_inset Graphics filename quit.png + lyxscale 70 + scale 40 \end_inset -Salir Sale del programa. + +\family sans +Salir +\layout Standard + +Sale del programa. La planta con la que estaba trabajando actualmente será descartada. \layout Paragraph @@ -183,25 +214,38 @@ Edici En este menú se encuentran los comandos para trabajar con los elementos de la planta. -\layout Description +\layout Standard \begin_inset Graphics filename delete.png + lyxscale 70 + scale 40 \end_inset -Borrar Borra el elemento seleccionado actualmente. -\layout Description + +\family sans +Borrar +\layout Standard + +Borra el elemento seleccionado actualmente. +\layout Standard \begin_inset Graphics filename clear.png + lyxscale 70 + scale 40 \end_inset -Borrar\SpecialChar ~ -Todo Borra todos los elementos de la planta. + +\family sans +Borrar Todo +\layout Standard + +Borra todos los elementos de la planta. Es equivalente a \family sans Archivo\SpecialChar \menuseparator @@ -229,7 +273,7 @@ Barra de herramientas. La barra de herramientas \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -262,27 +306,34 @@ Barra de herramientas. Barra de menú \family default y está dividida en dos. - En la parte superior se encuentran íconos para ejecutar los comandos (del - menú principal) más comunes del programa, como empezar una planta nueva, - guardar la planta actual y abrir una planta existente. + En la parte superior se encuentran iconos para realizar las tareas más + comunes del programa, como empezar una planta nueva, guardar la planta + actual y abrir una planta existente. \layout Standard En la parte inferior se encuentran herramientas adicionales útiles a la hora de trabajar con la planta. -\layout Description +\layout Paragraph -Verificar\SpecialChar ~ -Conexionado Verifica que todos los elementos estén conectados, - y formen un circuito de manera que pudierda fluir un líquido. -\layout Description +Verificar Conexionado. +\layout Standard -Lista Ubicada en la segunda posición de la barra, indica cuál fué el último - elemento seleccionado mediante un click del mouse, y almacena todos los - nombres de los elementos que fueron seleccionados. -\layout Description +Verifica que todos los elementos estén conectados, y formen un circuito + de manera que pueda fluir un líquido. +\layout Paragraph + +Selector de Ítem. +\layout Standard + +Es la lista desplegable ubicada en la segunda posición de la barra, indica + cuál fue el último elemento seleccionado y almacena todos los nombres de + los elementos que fueron seleccionados para buscarlos fácilmente. +\layout Paragraph + +Buscar. +\layout Standard -Buscar Marca con un recuadro negro el elemento ingresado en el campo de - texto +Marca con un recuadro negro el elemento ingresado en el campo de texto \begin_inset Float figure wide false collapsed false @@ -319,15 +370,15 @@ Buscar un elemento. Barra de elementos de planta. \layout Standard -Es la barra de íconos que se encuentra a la izquierda. - En ella están todos los elementos (físicos) que pueden ser incluídos en +Es la barra de iconos que se encuentra a la izquierda. + En ella están todos los elementos (físicos) que pueden ser incluidos en una planta. \layout Subsubsection Barra de compuertas lógicas. \layout Standard -Es la barra de íconos que se encuentra a la derecha. +Es la barra de iconos que se encuentra a la derecha. En esta barra se encuentran las compuertas lógicas para diseñar el comportamien to dinámico de la planta. Las compuertas son AND, OR y NOT. @@ -344,40 +395,8 @@ na informaci Área de trabajo. \layout Standard -Es el espacio grillado central, en ella se arrastran y sueltan los elementos +Es el espacio grillado central, en él se arrastran y sueltan los elementos de una planta para su diseño. -\layout Standard - -En la figura -\begin_inset LatexCommand \ref{cap:Vista_general} - -\end_inset - - se puede ver el área de trabajo completa. -\layout Standard - - -\begin_inset Float figure -wide false -collapsed false - -\layout Caption - - -\begin_inset LatexCommand \label{cap:Vista_general} - -\end_inset - -Ventana Principal -\begin_inset Graphics - filename general.png - -\end_inset - - -\end_inset - - \layout Section Guardar y recuperar el trabajo. @@ -391,9 +410,11 @@ Para abrir un archivo tiene dos formas: desde el men Archivo\SpecialChar \menuseparator Abrir \family default - o presionando sobre el ícono + o presionando sobre el icono \begin_inset Graphics filename open.png + lyxscale 70 + scale 40 \end_inset @@ -420,56 +441,89 @@ De manera similar a la carga o apertura de una planta, se puede guardar Para esto también hay dos formas distintas: \family sans Archivo\SpecialChar \menuseparator -Salvar +Guardar Como ... + \family default - o presionando sobre el ícono + o presionando sobre el icono +\begin_inset Graphics + filename save.png + lyxscale 70 + scale 40 + +\end_inset + + de la \family sans -Salvar +Barra de herramientas \family default - de la barra de herramientas. +. \layout Standard -La primera vez que el archivo sea guardado, se abrirá un diálogo para selecciona -r la ubicación donde desee guardarse, luego al presionar el botón en la - barra de herramientas que realiza esta acción, se sobreescribirá el archivo. +La primera vez que el archivo sea guardado, se abrirá una ventana de diálogo + para seleccionar la ubicación donde desee guardarlo, una vez guardado, + para volver a hacer sin que le pregunte la ubicación puede utilizar el + icono +\begin_inset Graphics + filename save.png + lyxscale 70 + scale 40 + +\end_inset + + de la +\family sans +Barra de herramientas +\family default +. \layout Standard Si se desea guardar el archivo con otro nombre o en otra ubicación, siempre - estará disponible la primera opción, que en todos los casos mostrará el - diálogo correspondiente. + podrá utilizar la opción +\family sans +Archivo\SpecialChar \menuseparator +Guardar Como ... + +\family default + que mostrará la ventana de diálogo correspondiente para grabar el archivo + con un nombre arbitrario. \layout Standard Para poder guardar un archivo de planta, esta debe estar correctamente conectada , esto puede verificarse presionando el botón de la barra de herramientas -\begin_inset Quotes eld -\end_inset - +\family sans Verificar Conexionado -\begin_inset Quotes erd -\end_inset - - el cual desplegará un diálogo de error, indicamdo cual es el elemento que - no verifica, si no se cumple la condición o un diálogo de éxito si todo - es correcto. +\family default + que indica si la conexión es correcta, desplegando una ventana de diálogo + con un mensaje. + En caso de error se indica qué elemento no se encuentra bien conectado. \layout Subsection Empezar una planta nueva. \layout Standard -Para comenzar a editar una planta nueva debe presionarse el botón en el - menú principal +Para comenzar a editar una planta nueva debe seleccionar la opción del menú + \family sans Archivo\SpecialChar \menuseparator Nuevo \family default -o directamente desde el acceso rápido en la barra de herramientas presionando - el botón con el mismo ícono, que se encuentra en la primera posición. -\layout Standard +o sobre el icono +\begin_inset Graphics + filename new.png + lyxscale 70 + scale 40 + rotateOrigin center + +\end_inset -Luego de este procedimiento, si el usuario desea guardar nuevamente el trabajo, - volverá a aparecer el diálogo para seleccionar la ubicación y nombre del - archivo por primera vez. + de la +\family sans +Barra de herramientas +\family default +. + A partir de este momento si desea guardar la planta aparecerá nuevamente + la ventana de diálogo para elegir un nombre de archivo incondicionalmente. \layout Section Salir del programa. @@ -506,6 +560,212 @@ A continuaci Diseño Físico de la planta. \layout Subsection +Elementos disponibles. +\layout Standard + +A continuación se da una lista de elementos físicos disponibles para crear + un planta. +\layout Standard + + +\begin_inset Tabular + + + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/canio_n.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Tubo de transporte de fluido. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/codo_o.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Codo para desviar el flujo. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/y_n.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Empalme. + Puede comportarse como una unión o división del flujo. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/tanque_e.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Tanque para almacenamiento de fluido. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/bomba_e.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Bomba. + Fuente de fluido. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/exclusa_h.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Exclusa. + Si esta cerrada corta el flujo, si está abierta no limita su caudal. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/drain_n.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Drenaje. + Sumidero de fluido. +\end_inset + + + + +\end_inset + + +\layout Subsection + Agregar un elemento. \layout Standard @@ -561,11 +821,11 @@ Propiedades cambiar las siguiente propiedades: \layout Description -Nombre Nombre e identificador unico del elemento (todos). +Nombre Nombre e identificador único del elemento (todos). \layout Description Flujo\SpecialChar ~ -Maximo Indica el flujo maximo que puede pasar por el elemento (tubo, +Máximo Indica el flujo máximo que puede pasar por el elemento (tubo, codo, empalme y bomba). \layout Description @@ -574,7 +834,7 @@ Estado Estado del elemento: Abierto o Cerrado (exclusa). Tipo\SpecialChar ~ de\SpecialChar ~ -Conexion Define como se comporta el elemento: Union o Division (empalme). +Conexión Define como se comporta el elemento: Unión o División (empalme). \layout Description Color Color del flujo que esta pasando actualmente por el elemento (bomba @@ -582,7 +842,7 @@ Color Color del flujo que esta pasando actualmente por el elemento (bomba \layout Description Capacidad\SpecialChar ~ -Maxima Capacidad de almacenamiento de fluidos del elemento (tanque). +Máxima Capacidad de almacenamiento de fluidos del elemento (tanque). \layout Description Contenido\SpecialChar ~ @@ -591,10 +851,10 @@ Inicial Cantidad de flujo almacenado inicialmente en el elemento \layout Standard La ventana de propiedades del tubo, el codo, el drenaje y el empalme son - practicamente iguales + prácticamente iguales \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -641,7 +901,7 @@ Propiedades del Tubo y Empalme. Para la bomba y el tanque aparecerán ventanas similares \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -688,17 +948,17 @@ Propiedades del Tanque y la Bomba. Al presionar el botón Color, se abrirá una nueva ventana de dialogo \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption -Seleccion de color. +Selección de color. \layout Standard \align center \begin_inset Graphics filename color_dlg.png - width 12cm + width 11cm keepAspectRatio \end_inset @@ -706,7 +966,8 @@ Seleccion de color. \end_inset - que permite seleccionar el mismo (ver figura + que permite seleccionar el color del fluido que el elemento almacena (ver + figura \begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque} \end_inset @@ -714,7 +975,7 @@ Seleccion de color. ). \layout Standard -Las compuertas lógicas no tienen la capacidad de modificar sus propiedades. +Las compuertas lógicas no tienen propiedades que se puedan modificar. \layout Subsection Eliminar un elemento. @@ -737,7 +998,7 @@ Eliminar Mover un elemento. \layout Standard -Puede mover un elemento arrastrandolo y soltándolo desde una ubicación del +Puede mover un elemento arrastrándolo y soltándolo desde una ubicación del \family sans Área de trabajo @@ -751,18 +1012,119 @@ Dise Para agregar un circuito lógico a la planta debe agregar compuertas lógicas. \layout Standard -El agregado de las compuertas es tan simple como el de los demás elementos, - de la misma forma estas pueden rotar para acomodarse a las necesidades - del diseñador. +El agregado de las compuertas es tan simple como el de los demás elementos. + También pueden ser rotadas, incluso en el modo +\family sans +Lógica +\family default +. +\layout Subsection + +Elementos disponibles. +\layout Standard + +A continuación se da una lista de elementos lógicos disponibles para crear + un circuito de control. +\layout Standard + + +\begin_inset Tabular + + + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/and_e.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Llave lógica AND. + La salida tiene nivel alto sólo si todas las entradas también lo tienen. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\begin_inset Graphics + filename ../pixmaps/or_e.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Llave lógica OR. + La salida tiene nivel bajo sólo si todas las entradas también lo tienen. +\end_inset + + + + +\begin_inset Text + \layout Standard -Básicamente la conexión lógica se realiza en tres pasos: + +\begin_inset Graphics + filename ../pixmaps/not_e.png + lyxscale 50 + scale 25 + +\end_inset + + +\end_inset + + +\begin_inset Text + +\layout Standard + +Llave lógica NOT. + La salida tiene nivel bajo si la entrada tiene nivel alto y viceversa. +\end_inset + + + + +\end_inset + + \layout Subsection -Agregar compuertas logicas. +Agregar compuertas lógicas. \layout Standard -Al igual que para agregar elemento comunes, para agregar compuertas logicas +Al igual que para agregar elemento comunes, para agregar compuertas lógicas basta con arrastrarlas y soltarlas en el \family sans Área de trabajo @@ -770,7 +1132,7 @@ Al igual que para agregar elemento comunes, para agregar compuertas logicas \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -779,7 +1141,7 @@ collapsed true \end_inset -Agregar compuertas logicas. +Agregar compuertas lógicas. \layout Standard \align center @@ -802,10 +1164,18 @@ Agregar compuertas logicas. puede ver un ejemplo. \layout Subsection -Activar el modo de Logica. +Activar el modo +\family sans +Lógica +\family default +. \layout Standard -Para crear conexiones es necesario activar el modo de Lógica del +Para crear conexiones es necesario activar el modo +\family sans +Lógica +\family default + del \family sans Área de trabajo \family default @@ -825,9 +1195,9 @@ Mientras este estado se encuentre activo, no se podr en las posiciones de los elementos, ni agregar nuevos, pero si podrán rotarse. \layout Standard -Al mismo tiempo que se acciona la lógica, podran verse las zonas de conexion +Al mismo tiempo que se acciona la lógica, podrán verse las zonas de conexión de cada elemento que tenga una entrada o una salida (exclusas, tanques, - bombas y conectores logicos) + bombas y conectores lógicos) \begin_inset Float figure wide false collapsed false @@ -839,7 +1209,7 @@ collapsed false \end_inset -Modo de Logica. +Modo de Lógica. \layout Standard \align center @@ -866,12 +1236,12 @@ Modo de Logica. Conectar los elementos. \layout Standard -Todas las conexiones deben hacerse desde una compuerta logica hacia otro - elemento (comun u otra compuerta logica). - Para seleccionar la compuerta logica desde la cual comenzar la conexión +Todas las conexiones deben hacerse desde una compuerta lógica hacia otro + elemento (común u otra compuerta lógica). + Para seleccionar la compuerta lógica desde la cual comenzar la conexión simplemente haga click sobre la zona de conexión (entrada o salida). - A continuacion haga click en la zona de conexión del otro elmento y aparecera - una linea de color rojo o azul. + A continuación haga click en la zona de conexión del otro elemento y aparecerá + una línea de color rojo o azul. El azul indica una conexión entrante a la compuerta lógica y el rojo una conexión saliente de la compuerta lógica. Solo pueden hacerse conexiones desde la entrada de una compuerta lógica @@ -880,27 +1250,14 @@ Todas las conexiones deben hacerse desde una compuerta logica hacia otro roja). \layout Standard -Para conectar dos compuertas se debe clickear en primer lugar la salida - de la compuerta origen y en segunda instancia la entrada de la compuerta - destino. +Para conectar dos compuertas se debe hacer click con el puntero en la salida + de la compuerta lógica de origen y luego la entrada del elemento destino. \layout Standard -Las compuertas lógicas -\family sans -AND -\family default - y -\family sans -OR -\family default - pueden tener un número indefinido de entradas, mientras que la compuerta - -\family sans -NOT -\family default - puede debe tener solo una. +Las compuertas lógicas AND y OR pueden tener un número indefinido de entradas, + mientras que la compuerta NOT puede debe tener sólo una. Todas las compuertas pueden tener una sola salida. - Los elementos de transporte de flujo con zonas de conexion aceptan un número + Los elementos de transporte de flujo con zonas de conexión aceptan un número indefinido de conexiones. \layout Standard @@ -912,7 +1269,7 @@ En la figura se puede ver una planta terminada. \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -921,9 +1278,14 @@ collapsed true \end_inset -Planta Completa +Planta Completa. +\layout Standard +\align center + \begin_inset Graphics filename planta_logica.png + lyxscale 70 + width 14.7cm \end_inset diff --git a/TODO b/TODO index e67abcc..521574d 100644 --- a/TODO +++ b/TODO @@ -8,14 +8,13 @@ $Id$ d) Ver como poner y sacar flags de DEBUG en Autoconf/Automake (baja prioridad). 2) Terminar manuales. - a) Terminar manual de constructor. - b) (luca) Actualizar manual de cliente. - c) Hacer manuales derivados de Doxygen (limpiar un poco lo que genera). + a) (luca) Actualizar manual de cliente (faltan screenshots nomas). + b) Hacer manuales derivados de Doxygen (limpiar un poco lo que genera). i) (sagar) Agregar documentacion en linea que falta. ii) Armar manual de administrador (instalacion + manual de usuario del server). iii) Armar manual de desarrollo imprimible. - d) Hacer manual del proyecto. + c) Hacer manual del proyecto. i) Agregar como falencia lo de los sockets y algo mas? ii) Poner changelog (log del svn). iii) Problemas encontrados (sockets no bloqueantes, colores de gdk?, -- 2.43.0