X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/blobdiff_plain/e640dd82019d3885c4ddee748d6824d703653730..f935b3a37c3134004ec41eeea5dd1f6571804f81:/Constructor/doc/manual.lyx?ds=inline diff --git a/Constructor/doc/manual.lyx b/Constructor/doc/manual.lyx index a365621..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 @@ -78,19 +81,10 @@ Enter 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 - - +Una vez abierta la aplicación aparecerá la ventana principal \begin_inset Float figure wide false -collapsed true +collapsed false \layout Caption @@ -99,12 +93,12 @@ collapsed true \end_inset -Ventana principal de PlaQui Constructor +Ventana principal de PlaQui Constructor. \layout Standard - +\align center \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/principal.png + filename principal.png lyxscale 50 width 14.7cm keepAspectRatio @@ -114,7 +108,12 @@ Ventana principal de PlaQui Constructor \end_inset + que se puede ver en la figura +\begin_inset LatexCommand \vref{cap:Ventana-principal} + +\end_inset +. \layout Standard La ventana contiene los siguientes elementos: @@ -125,9 +124,6 @@ Barra de men 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 Comment - -En cada ítem de cada menú se podría agregar un ícono. \layout Paragraph Menú @@ -139,44 +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 /home/nico/plaqui/Constructor/doc/new.png + 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 /home/nico/plaqui/Constructor/doc/open.png + 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 /home/nico/plaqui/Constructor/doc/save.png + 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 /home/nico/plaqui/Constructor/doc/quit.png + 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 @@ -189,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 /home/nico/plaqui/Constructor/doc/delete.png + 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 /home/nico/plaqui/Constructor/doc/clear.png + 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 @@ -232,77 +270,118 @@ Acerca Obtiene informaci 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 /home/nico/plaqui/Constructor/doc/barra_herramientas.png + filename barra_herramientas.png + width 14.7cm + keepAspectRatio \end_inset -\layout Standard +\end_inset + + (figura +\begin_inset LatexCommand \ref{cap:Barra-de-herramientas.} + +\end_inset -En la barra de herramientas se encuentra debajo de la +) se encuentra debajo de la \family sans 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 Standard +\layout Paragraph +Verificar Conexionado. +\layout Standard -\series bold -Verificar Conexionado -\series default Verifica que todos los elementos estén conectados, y formen un circuito - de manera que pudierda fluir un líquido. + 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 -\series bold -Lista -\series default - 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. +Buscar. \layout Standard +Marca con un recuadro negro el elemento ingresado en el campo de texto +\begin_inset Float figure +wide false +collapsed false + +\layout Caption -\series bold -Buscar -\series default - Marca con un recuadro negro el elemento seleccionado (el que aparece en - la lista). -\layout Standard +\begin_inset LatexCommand \label{cap:Buscar-un-elemento.} + +\end_inset + +Buscar un elemento. +\layout Standard +\align center \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/buscar.png + filename buscar.png + width 10cm + keepAspectRatio + +\end_inset + \end_inset + (ver figura +\begin_inset LatexCommand \ref{cap:Buscar-un-elemento.} +\end_inset + +). \layout Subsubsection Barra de elementos de planta. \layout Standard -En 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 -En 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. \layout Subsubsection Barra de estado. @@ -316,7 +395,7 @@ 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 Section @@ -331,11 +410,19 @@ 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 + + de la \family sans -Abrir +Barra de herramientas \family default - de la barra de herramientas. +. En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar el archivo a abrir. Una vez seleccionado, presione @@ -344,17 +431,6 @@ Aceptar \family default . La planta aparecerá en la ventana principal. -\layout Comment - -En vez de poner -\begin_inset Quotes eld -\end_inset - -ícono Abrir -\begin_inset Quotes erd -\end_inset - - se podría poner una imágen bonita :) \layout Subsection Guardar un archivo de planta. @@ -365,39 +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 + +\family sans +Verificar Conexionado +\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 -Esta acción +\end_inset + + 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. @@ -432,9 +558,212 @@ A continuaci \layout Section Diseño Físico de la planta. -\layout Comment +\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 + -Mencionar el botón de verificar conexionado. \layout Subsection Agregar un elemento. @@ -482,28 +811,171 @@ Cambiar las propiedades de un elemento. \layout Standard Para modificar las propiedades de un elemento puede hacer doble-click sobre - el mismo. + el mismo o haciendo click con el botón derecho del puntero y seleccionando + la opción +\family sans +Propiedades +\family default + del menú contextual. Esto abre una ventana de diálogo que, según el tipo de elemento le permitirá cambiar las siguiente propiedades: \layout Description -Nombre Nombre del elemento. - Este nombre se utiliza para identificar este elemento para poder controlarlo - desde la aplicación de control. -\layout Comment +Nombre Nombre e identificador único del elemento (todos). +\layout Description -Poner las otras propiedades que pueden modificarse. -\layout Comment +Flujo\SpecialChar ~ +Máximo Indica el flujo máximo que puede pasar por el elemento (tubo, + codo, empalme y bomba). +\layout Description -Poner screenshots??? +Estado Estado del elemento: Abierto o Cerrado (exclusa). +\layout Description + +Tipo\SpecialChar ~ +de\SpecialChar ~ +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 + y tanque). +\layout Description + +Capacidad\SpecialChar ~ +Máxima Capacidad de almacenamiento de fluidos del elemento (tanque). +\layout Description + +Contenido\SpecialChar ~ +Inicial Cantidad de flujo almacenado inicialmente en el elemento + (tanque). \layout Standard -La ventana de diálogo de propiedades también puede abrirse haciendo click - con el botón derecho del puntero y seleccionando la opción -\family sans -Propiedades -\family default - del menú contextual. +La ventana de propiedades del tubo, el codo, el drenaje y el empalme son + prácticamente iguales +\begin_inset Float figure +wide false +collapsed false + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Propiedades-del-Tubo} + +\end_inset + +Propiedades del Tubo y Empalme. +\layout Standard +\align center + +\begin_inset Graphics + filename tubo_props.png + width 6cm + keepAspectRatio + subcaption + subcaptionText "Tubo" + +\end_inset + + +\begin_inset Graphics + filename empalme_props.png + width 6cm + keepAspectRatio + subcaption + subcaptionText "Empalme" + +\end_inset + + +\end_inset + + (ver figura +\begin_inset LatexCommand \ref{cap:Propiedades-del-Tubo} + +\end_inset + +), a este último elemento se le agrega la opción de seleccionar si es una + unión o una división, y el drenaje solo posee la propiedad Nombre. +\layout Standard + +Para la bomba y el tanque aparecerán ventanas similares +\begin_inset Float figure +wide false +collapsed false + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Propiedades-del-Tanque} + +\end_inset + +Propiedades del Tanque y la Bomba. +\layout Standard +\align center + +\begin_inset Graphics + filename tanque_props.png + width 7cm + keepAspectRatio + subcaption + subcaptionText "Tanque" + +\end_inset + + +\begin_inset Graphics + filename bomba_props.png + width 7cm + keepAspectRatio + subcaption + subcaptionText "Bomba" + +\end_inset + + +\end_inset + + (ver figura +\begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque} + +\end_inset + +), pero estos elementos tienen la capacidad de definir, además del nombre, + el color del fluido que almacenan o entregan. +\layout Standard + +Al presionar el botón Color, se abrirá una nueva ventana de dialogo +\begin_inset Float figure +wide false +collapsed false + +\layout Caption + +Selección de color. +\layout Standard +\align center + +\begin_inset Graphics + filename color_dlg.png + width 11cm + keepAspectRatio + +\end_inset + + +\end_inset + + que permite seleccionar el color del fluido que el elemento almacena (ver + figura +\begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque} + +\end_inset + +). +\layout Standard + +Las compuertas lógicas no tienen propiedades que se puedan modificar. \layout Subsection Eliminar un elemento. @@ -526,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 @@ -538,20 +1010,287 @@ Dise \layout Standard Para agregar un circuito lógico a la planta debe agregar compuertas lógicas. -\layout Comment +\layout Standard + +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 + -Comentar que primero hay que poner compuertas, después poner -\begin_inset Quotes eld \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 + + +\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 lógicas. +\layout Standard + +Al igual que para agregar elemento comunes, para agregar compuertas lógicas + basta con arrastrarlas y soltarlas en el +\family sans +Área de trabajo +\family default + +\begin_inset Float figure +wide false +collapsed false + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Agregar-compuertas-logicas.} + +\end_inset + +Agregar compuertas lógicas. +\layout Standard +\align center + +\begin_inset Graphics + filename conectando.png + lyxscale 70 + width 14.7cm + +\end_inset + + +\end_inset + +. + En la figura +\begin_inset LatexCommand \ref{cap:Agregar-compuertas-logicas.} + +\end_inset + + puede ver un ejemplo. +\layout Subsection + +Activar el modo +\family sans +Lógica +\family default +. +\layout Standard + +Para crear conexiones es necesario activar el modo +\family sans +Lógica +\family default + del +\family sans +Área de trabajo +\family default +. + Esto se hace haciendo click en la caja de selección +\family sans Lógica -\begin_inset Quotes erd +\family default + que se encuentra en la +\family sans +Barra de herramientas +\family default +. +\layout Standard + +Mientras este estado se encuentre activo, no se podrán realizar cambios + 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, podrán verse las zonas de conexión + de cada elemento que tenga una entrada o una salida (exclusas, tanques, + bombas y conectores lógicos) +\begin_inset Float figure +wide false +collapsed false + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Modo-de-Logica.} + +\end_inset + +Modo de Lógica. +\layout Standard +\align center + +\begin_inset Graphics + filename logica.png + lyxscale 70 + width 14.7cm + +\end_inset + + \end_inset - y empezar a conectar. -\layout Comment +. + Las salidas se identifican con el color azul y las entradas con el rojo. + En la figura +\begin_inset LatexCommand \ref{cap:Modo-de-Logica.} + +\end_inset -Explicar tema de los colores (cual es entrada y cual salida) y las limitaciones - de cada elemento (cuantas entradas soporta cada compuerta lógica, cuantas - salidas, que tipo de entradas y salidas tiene cada elemento de la planta). + puede ver un ejemplo. +\layout Subsection + +Conectar los elementos. +\layout Standard + +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 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 + (zona roja) a la salida de otro elemento (zona azul) o desde una salida + de una compuerta lógica (zona azul) a la entrada de otro elemento (zona + roja). +\layout Standard + +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 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 conexión aceptan un número + indefinido de conexiones. +\layout Standard + +En la figura +\begin_inset LatexCommand \ref{cap:Planta_logica} + +\end_inset + + se puede ver una planta terminada. +\begin_inset Float figure +wide false +collapsed false + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Planta_logica} + +\end_inset + +Planta Completa. +\layout Standard +\align center + +\begin_inset Graphics + filename planta_logica.png + lyxscale 70 + width 14.7cm + +\end_inset + + +\end_inset + + \the_end