X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/blobdiff_plain/76e4d0ac5dda0eb6c7826c6fb8100956e40bd148..4341c033f13578b5b3aeb3e08e20d3889cb2d7c7:/Constructor/doc/manual.lyx diff --git a/Constructor/doc/manual.lyx b/Constructor/doc/manual.lyx index 676d1a3..217a81f 100644 --- a/Constructor/doc/manual.lyx +++ b/Constructor/doc/manual.lyx @@ -78,16 +78,7 @@ 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 @@ -99,12 +90,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 +105,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 +121,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ú @@ -143,7 +136,8 @@ En este men \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/new.png + filename new.png + rotateOrigin center \end_inset @@ -153,7 +147,7 @@ Nuevo Empieza a construir una planta nueva. \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/open.png + filename open.png \end_inset @@ -163,7 +157,7 @@ Abrir Abre una planta nueva. \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/save.png + filename save.png \end_inset @@ -172,7 +166,7 @@ Guardar Guarda la planta actual. \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/quit.png + filename quit.png \end_inset @@ -193,7 +187,7 @@ En este men \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/delete.png + filename delete.png \end_inset @@ -202,7 +196,7 @@ Borrar Borra el elemento seleccionado actualmente. \begin_inset Graphics - filename /home/nico/plaqui/Constructor/doc/clear.png + filename clear.png \end_inset @@ -232,21 +226,38 @@ Acerca Obtiene informaci Barra de herramientas. \layout Standard +La barra de herramientas +\begin_inset Float figure +wide false +collapsed true + +\layout Caption + -\begin_inset External ChessDiagram,"","" +\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 -En la barra de herramientas se encuentra debajo de la + (figura +\begin_inset LatexCommand \ref{cap:Barra-de-herramientas.} + +\end_inset + +) se encuentra debajo de la \family sans Barra de menú \family default @@ -258,46 +269,57 @@ Barra de men En la parte inferior se encuentran herramientas adicionales útiles a la hora de trabajar con la planta. -\layout Standard +\layout Description +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 -\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. -\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 +Buscar Marca con un recuadro negro el elemento ingresado en el campo de + texto +\begin_inset Float figure +wide false +collapsed true -\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. -\layout Standard +\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. +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 una planta. \layout Subsubsection @@ -305,9 +327,10 @@ En la barra de Barra de compuertas lógicas. \layout Standard -En la barra de íconos que se encuentra a la derecha. +Es la barra de íconos 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. @@ -323,6 +346,13 @@ na informaci Es el espacio grillado central, en ella se arrastran y sueltan los elementos de una planta para su diseño. +\layout Comment + +ACA ESTARIA BUENO PONER UNA IMAGEN DE TODA LA PANTALLA INDICANDO QUE ES + CADA COSA +\layout Comment + +( DENTRO DE LA MISMA IMAGEN) \layout Section Guardar y recuperar el trabajo. @@ -337,10 +367,16 @@ Archivo\SpecialChar \menuseparator Abrir \family default o presionando sobre el ícono +\begin_inset Graphics + filename open.png + +\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 @@ -349,34 +385,66 @@ Aceptar \family default . La planta aparecerá en la ventana principal. -\layout Comment +\layout Subsection -En vez de poner +Guardar un archivo de planta. +\layout Standard + +De manera similar a la carga o apertura de una planta, se puede guardar + o salvar la misma. + Para esto también hay dos formas distintas: +\family sans + Archivo\SpecialChar \menuseparator +Salvar +\family default + o presionando sobre el ícono +\family sans +Salvar +\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. +\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. +\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 -ícono Abrir +Verificar Conexionado \begin_inset Quotes erd \end_inset - se podría poner una imágen bonita :) + 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. \layout Subsection -Guardar un archivo de planta. +Empezar una planta nueva. \layout Standard -De manera similar a la carga o apertura de una planta, se puede guardar - o salvar la misma. - Para esto también hay dos formas distintas: +Para comenzar a editar una planta nueva debe presionarse el botón en el + menú principal \family sans Archivo\SpecialChar \menuseparator -Salvar -\layout Subsection - -Empezar una planta nueva. -\layout Comment +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 -Idem anterior. +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. \layout Section Salir del programa. @@ -411,9 +479,6 @@ A continuaci \layout Section Diseño Físico de la planta. -\layout Comment - -Mencionar el botón de verificar conexionado. \layout Subsection Agregar un elemento. @@ -461,28 +526,170 @@ 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 unico del elemento (todos). +\layout Description -Poner las otras propiedades que pueden modificarse. -\layout Comment +Flujo\SpecialChar ~ +Maximo Indica el flujo maximo que puede pasar por el elemento (tubo, + codo, empalme y bomba). +\layout Description + +Estado Estado del elemento: Abierto o Cerrado (exclusa). +\layout Description + +Tipo\SpecialChar ~ +de\SpecialChar ~ +Conexion Define como se comporta el elemento: Union o Division (empalme). +\layout Description + +Color Color del flujo que esta pasando actualmente por el elemento (bomba + y tanque). +\layout Description + +Capacidad\SpecialChar ~ +Maxima Capacidad de almacenamiento de fluidos del elemento (tanque). +\layout Description -Poner screenshots??? +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 + practicamente 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 true + +\layout Caption + +Seleccion de color. +\layout Standard +\align center + +\begin_inset Graphics + filename color_dlg.png + width 12cm + keepAspectRatio + +\end_inset + + +\end_inset + + que permite seleccionar el mismo (ver figura +\begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque} + +\end_inset + +). +\layout Standard + +Las compuertas lógicas no tienen la capacidad de modificar sus propiedades. \layout Subsection Eliminar un elemento. @@ -517,20 +724,152 @@ 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, + de la misma forma estas pueden rotar para acomodarse a las necesidades + del diseñador. +\layout Standard + +Básicamente la conexión lógica se realiza en tres pasos: +\layout Subsection + +Agregar compuertas logicas. +\layout Standard + +Al igual que para agregar elemento comunes, para agregar compuertas logicas + basta con arrastrarlas y soltarlas en el +\family sans +Área de trabajo +\family default + +\begin_inset Float figure +wide false +collapsed true + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Agregar-compuertas-logicas.} + +\end_inset + +Agregar compuertas logicas. +\layout Standard +\align center + +\begin_inset Graphics + filename conectando.png + lyxscale 70 + width 14.7cm -Comentar que primero hay que poner compuertas, después poner -\begin_inset Quotes eld \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 de Logica. +\layout Standard + +Para crear conexiones es necesario activar el modo de Lógica 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, podran verse las zonas de conexion + de cada elemento que tenga una entrada o una salida (exclusas, tanques, + bombas y conectores logicos) +\begin_inset Float figure +wide false +collapsed true + +\layout Caption + + +\begin_inset LatexCommand \label{cap:Modo-de-Logica.} + \end_inset - y empezar a conectar. -\layout Comment +Modo de Logica. +\layout Standard +\align center + +\begin_inset Graphics + filename logica.png + lyxscale 70 + width 14.7cm + +\end_inset + + +\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). +. + 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 + + puede ver un ejemplo. +\layout Subsection + +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 conexion + simplemente haga click sobre la zona de conexion (entrada o salida). + A continuacion haga click en la zona de conexion del otro elmento y aparecera + una linea de color rojo o azul. + El azul indica una conexion entrante a la compuerta logica y el rojo una + conexion saliente de la compuerta logica. + Solo pueden hacerse conexiones desde la entrada de una compuerta logica + (zona roja) a la salida de otro elemento (zona azul) o desde una salida + de una compuerta logica (zona azul) a la entrada de otro elemento (zona + roja). +\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. + Todas las compuertas pueden tener una sola salida. + Los elementos comunes con zonas de conexion aceptan un numero indefinido + de conexiones. \the_end