]> git.llucax.com Git - z.facultad/75.42/plaqui.git/blob - Constructor/doc/manual.lyx
Se agrega al EXAMPLE_PATH Constructor/doc para los ejemplos de XML.
[z.facultad/75.42/plaqui.git] / Constructor / doc / manual.lyx
1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 221
3 \textclass book
4 \language spanish
5 \inputencoding auto
6 \fontscheme palatino
7 \graphics default
8 \float_placement !htb
9 \paperfontsize default
10 \spacing single 
11 \papersize a4paper
12 \paperpackage widemarginsa4
13 \use_geometry 0
14 \use_amsmath 0
15 \use_natbib 0
16 \use_numerical_citations 0
17 \paperorientation portrait
18 \secnumdepth 3
19 \tocdepth 3
20 \paragraph_separation indent
21 \defskip medskip
22 \quotes_language english
23 \quotes_times 2
24 \papercolumns 1
25 \papersides 2
26 \paperpagestyle default
27
28 \layout Title
29
30 PlaQui Constructor
31 \newline 
32 Manual de Usuario
33 \layout Author
34
35 Nicolás Dimov
36 \newline 
37 Leandro Lucarella
38 \newline 
39 Ricardo Markiewicz
40 \layout Standard
41
42
43 \begin_inset LatexCommand \tableofcontents{}
44
45 \end_inset 
46
47
48 \layout Chapter
49
50 Introducción.
51 \layout Standard
52
53 PlaQui es un conjunto de aplicaciones para diseño, simulación y control
54  de plantas químicas.
55 \layout Standard
56
57 PlaQui Constructor es la aplicación para diseñar y construir la planta química.
58  Con este programa se puede diseñar fácilmente tanto la distribución física
59  de la planta y sus componentes como las conexiones lógicas para su correcto
60  funcionamiento.
61 \layout Section
62
63 Abrir la aplicación.
64 \layout Standard
65
66 Para abrir la aplicación basta con ejecutarla desde la línea de comandos.
67  Escriba 
68 \family typewriter 
69 plaqui-constructor
70 \family default 
71  y presione 
72 \family typewriter 
73 Enter
74 \family default 
75 .
76 \layout Subsection
77
78 Pantalla inicial.
79 \layout Standard
80
81 Una vez abierta la aplicación aparecerá la ventana principal 
82 \begin_inset Float figure
83 wide false
84 collapsed true
85
86 \layout Caption
87
88
89 \begin_inset LatexCommand \label{cap:Ventana-principal}
90
91 \end_inset 
92
93 Ventana principal de PlaQui Constructor.
94 \layout Standard
95 \align center 
96
97 \begin_inset Graphics
98         filename principal.png
99         lyxscale 50
100         width 14.7cm
101         keepAspectRatio
102
103 \end_inset 
104
105
106 \end_inset 
107
108  que se puede ver en la figura 
109 \begin_inset LatexCommand \vref{cap:Ventana-principal}
110
111 \end_inset 
112
113 .
114 \layout Standard
115
116 La ventana contiene los siguientes elementos:
117 \layout Subsubsection
118
119 Barra de menú.
120 \layout Standard
121
122 En la barra de menú se encuentra en la parte superior de la ventana y en
123  ella están todas los comandos para trabajar con el programa.
124 \layout Paragraph
125
126 Menú 
127 \family sans 
128 Archivo
129 \family default 
130 .
131 \layout Standard
132
133 En este menú se encuentran todos los comandos para manejar archivos y salir
134  del programa.
135 \layout Description
136
137
138 \begin_inset Graphics
139         filename new.png
140         rotateOrigin center
141
142 \end_inset 
143
144 Nuevo Empieza a construir una planta nueva.
145  La planta con la que estaba trabajando actualmente será descartada.
146 \layout Description
147
148
149 \begin_inset Graphics
150         filename open.png
151
152 \end_inset 
153
154 Abrir Abre una planta nueva.
155  La planta con la que estaba trabajando actualmente será descartada.
156 \layout Description
157
158
159 \begin_inset Graphics
160         filename save.png
161
162 \end_inset 
163
164 Guardar Guarda la planta actual.
165 \layout Description
166
167
168 \begin_inset Graphics
169         filename quit.png
170
171 \end_inset 
172
173 Salir Sale del programa.
174  La planta con la que estaba trabajando actualmente será descartada.
175 \layout Paragraph
176
177 Menú 
178 \family sans 
179 Edición
180 \family default 
181 .
182 \layout Standard
183
184 En este menú se encuentran los comandos para trabajar con los elementos
185  de la planta.
186 \layout Description
187
188
189 \begin_inset Graphics
190         filename delete.png
191
192 \end_inset 
193
194 Borrar Borra el elemento seleccionado actualmente.
195 \layout Description
196
197
198 \begin_inset Graphics
199         filename clear.png
200
201 \end_inset 
202
203 Borrar\SpecialChar ~
204 Todo Borra todos los elementos de la planta.
205  Es equivalente a 
206 \family sans 
207 Archivo\SpecialChar \menuseparator
208 Nuevo
209 \family default 
210 .
211 \layout Paragraph
212
213 Menú 
214 \family sans 
215 Ayuda
216 \family default 
217 .
218 \layout Standard
219
220 En este menú se encuentran los comandos para obtener ayuda.
221 \layout Description
222
223 Acerca Obtiene información acerca de la aplicación.
224 \layout Subsubsection
225
226 Barra de herramientas.
227 \layout Standard
228
229 La barra de herramientas
230 \begin_inset Float figure
231 wide false
232 collapsed true
233
234 \layout Caption
235
236
237 \begin_inset LatexCommand \label{cap:Barra-de-herramientas.}
238
239 \end_inset 
240
241 Barra de herramientas.
242 \layout Standard
243 \align center 
244
245 \begin_inset Graphics
246         filename barra_herramientas.png
247         width 14.7cm
248         keepAspectRatio
249
250 \end_inset 
251
252
253 \end_inset 
254
255  (figura 
256 \begin_inset LatexCommand \ref{cap:Barra-de-herramientas.}
257
258 \end_inset 
259
260 ) se encuentra debajo de la 
261 \family sans 
262 Barra de menú
263 \family default 
264  y está dividida en dos.
265  En la parte superior se encuentran íconos para ejecutar los comandos (del
266  menú principal) más comunes del programa, como empezar una planta nueva,
267  guardar la planta actual y abrir una planta existente.
268 \layout Standard
269
270 En la parte inferior se encuentran herramientas adicionales útiles a la
271  hora de trabajar con la planta.
272 \layout Description
273
274 Verificar\SpecialChar ~
275 Conexionado Verifica que todos los elementos estén conectados,
276  y formen un circuito de manera que pudierda fluir un líquido.
277 \layout Description
278
279 Lista Ubicada en la segunda posición de la barra, indica cuál fué el último
280  elemento seleccionado mediante un click del mouse, y almacena todos los
281  nombres de los elementos que fueron seleccionados.
282 \layout Description
283
284 Buscar Marca con un recuadro negro el elemento ingresado en el campo de
285  texto
286 \begin_inset Float figure
287 wide false
288 collapsed false
289
290 \layout Caption
291
292
293 \begin_inset LatexCommand \label{cap:Buscar-un-elemento.}
294
295 \end_inset 
296
297 Buscar un elemento.
298 \layout Standard
299 \align center 
300
301 \begin_inset Graphics
302         filename buscar.png
303         width 10cm
304         keepAspectRatio
305
306 \end_inset 
307
308
309 \end_inset 
310
311  (ver figura 
312 \begin_inset LatexCommand \ref{cap:Buscar-un-elemento.}
313
314 \end_inset 
315
316 ).
317 \layout Subsubsection
318
319 Barra de elementos de planta.
320 \layout Standard
321
322 Es la barra de íconos que se encuentra a la izquierda.
323  En ella están todos los elementos (físicos) que pueden ser incluídos en
324  una planta.
325 \layout Subsubsection
326
327 Barra de compuertas lógicas.
328 \layout Standard
329
330 Es la barra de íconos que se encuentra a la derecha.
331  En esta barra se encuentran las compuertas lógicas para diseñar el comportamien
332 to dinámico de la planta.
333  Las compuertas son AND, OR y NOT.
334 \layout Subsubsection
335
336 Barra de estado.
337 \layout Standard
338
339 Esta barra se encuentra en la parte inferior de la ventana principal y proporcio
340 na información adicional útil a la hora de trabajar con una planta, como
341  las propiedades del elemento seleccionado.
342 \layout Subsubsection
343
344 Área de trabajo.
345 \layout Standard
346
347 Es el espacio grillado central, en ella se arrastran y sueltan los elementos
348  de una planta para su diseño.
349 \layout Standard
350
351 En la figura 
352 \begin_inset LatexCommand \ref{cap:Vista_general}
353
354 \end_inset 
355
356  se puede ver el área de trabajo completa.
357 \layout Standard
358
359
360 \begin_inset Float figure
361 wide false
362 collapsed false
363
364 \layout Caption
365
366
367 \begin_inset LatexCommand \label{cap:Vista_general}
368
369 \end_inset 
370
371 Ventana Principal
372 \begin_inset Graphics
373         filename general.png
374
375 \end_inset 
376
377
378 \end_inset 
379
380
381 \layout Section
382
383 Guardar y recuperar el trabajo.
384 \layout Subsection
385
386 Abrir un archivo de planta.
387 \layout Standard
388
389 Para abrir un archivo tiene dos formas: desde el menú 
390 \family sans 
391 Archivo\SpecialChar \menuseparator
392 Abrir
393 \family default 
394  o presionando sobre el ícono 
395 \begin_inset Graphics
396         filename open.png
397
398 \end_inset 
399
400  de la 
401 \family sans 
402 Barra de herramientas
403 \family default 
404 .
405  En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar
406  el archivo a abrir.
407  Una vez seleccionado, presione 
408 \family sans 
409 Aceptar
410 \family default 
411 .
412  La planta aparecerá en la ventana principal.
413 \layout Subsection
414
415 Guardar un archivo de planta.
416 \layout Standard
417
418 De manera similar a la carga o apertura de una planta, se puede guardar
419  o salvar la misma.
420  Para esto también hay dos formas distintas:
421 \family sans 
422  Archivo\SpecialChar \menuseparator
423 Salvar
424 \family default 
425  o presionando sobre el ícono 
426 \family sans 
427 Salvar
428 \family default 
429  de la barra de herramientas.
430 \layout Standard
431
432 La primera vez que el archivo sea guardado, se abrirá un diálogo para selecciona
433 r la ubicación donde desee guardarse, luego al presionar el botón en la
434  barra de herramientas que realiza esta acción, se sobreescribirá el archivo.
435 \layout Standard
436
437 Si se desea guardar el archivo con otro nombre o en otra ubicación, siempre
438  estará disponible la primera opción, que en todos los casos mostrará el
439  diálogo correspondiente.
440 \layout Standard
441
442 Para poder guardar un archivo de planta, esta debe estar correctamente conectada
443 , esto puede verificarse presionando el botón de la barra de herramientas
444  
445 \begin_inset Quotes eld
446 \end_inset 
447
448 Verificar Conexionado
449 \begin_inset Quotes erd
450 \end_inset 
451
452  el cual desplegará un diálogo de error, indicamdo cual es el elemento que
453  no verifica, si no se cumple la condición o un diálogo de éxito si todo
454  es correcto.
455 \layout Subsection
456
457 Empezar una planta nueva.
458 \layout Standard
459
460 Para comenzar a editar una planta nueva debe presionarse el botón en el
461  menú principal 
462 \family sans 
463 Archivo\SpecialChar \menuseparator
464 Nuevo 
465 \family default 
466 o directamente desde el acceso rápido en la barra de herramientas presionando
467  el botón con el mismo ícono, que se encuentra en la primera posición.
468 \layout Standard
469
470 Luego de este procedimiento, si el usuario desea guardar nuevamente el trabajo,
471  volverá a aparecer el diálogo para seleccionar la ubicación y nombre del
472  archivo por primera vez.
473 \layout Section
474
475 Salir del programa.
476 \layout Standard
477
478 Para salir del programa puede presionar sobre la cruz que generalmente se
479  encuentra en la esquina superior derecha de la ventana principal (esto
480  depende de su manejador de ventanas) o desde el menú 
481 \family sans 
482 Archivo\SpecialChar \menuseparator
483 Salir
484 \family default 
485 .
486 \layout Chapter
487
488 Crear una planta.
489 \layout Standard
490
491 Para crear una planta sólo tiene que arrastrar y soltar los elementos en
492  el área de trabajo.
493  Una vez conseguido el diseño físico de la planta puede empezar a arrastrar
494  y soltar compuertas lógicas para definir su comportamiento dinámico.
495  Finalmente, para hacer el conexionado lógico debe activar la caja de selección
496  
497 \family sans 
498 Lógica
499 \family default 
500  de la barra de herramientas.
501 \layout Standard
502
503 A continuación se detalla el proceso.
504 \layout Section
505
506 Diseño Físico de la planta.
507 \layout Subsection
508
509 Agregar un elemento.
510 \layout Standard
511
512 Para agregar un elemento hay que arrastrarlo y soltarlo desde la 
513 \family sans 
514 Barra de elementos
515 \family default 
516  al 
517 \family sans 
518 Área de trabajo
519 \family default 
520 .
521 \layout Subsection
522
523 Modificar un elemento.
524 \layout Standard
525
526 Para modificar un elemento primero debe seleccionarlo en el 
527 \family sans 
528 Área de trabajo
529 \family default 
530  y luego realizar alguna de las siguientes acciones:
531 \layout Subsubsection
532
533 Orientar un elemento.
534 \layout Standard
535
536 Para cambiar la orientación de un elemento puede hacer click con el botón
537  central del puntero o hacer click con el botón derecho y seleccionar la
538  opción 
539 \family sans 
540 Rotar
541 \family default 
542  del menú contextual.
543  Según el tipo de elemento puede ser que rote o se 
544 \emph on 
545 espeje
546 \emph default 
547 .
548 \layout Subsubsection
549
550 Cambiar las propiedades de un elemento.
551 \layout Standard
552
553 Para modificar las propiedades de un elemento puede hacer doble-click sobre
554  el mismo o haciendo click con el botón derecho del puntero y seleccionando
555  la opción 
556 \family sans 
557 Propiedades
558 \family default 
559  del menú contextual.
560  Esto abre una ventana de diálogo que, según el tipo de elemento le permitirá
561  cambiar las siguiente propiedades:
562 \layout Description
563
564 Nombre Nombre e identificador unico del elemento (todos).
565 \layout Description
566
567 Flujo\SpecialChar ~
568 Maximo Indica el flujo maximo que puede pasar por el elemento (tubo,
569  codo, empalme y bomba).
570 \layout Description
571
572 Estado Estado del elemento: Abierto o Cerrado (exclusa).
573 \layout Description
574
575 Tipo\SpecialChar ~
576 de\SpecialChar ~
577 Conexion Define como se comporta el elemento: Union o Division (empalme).
578 \layout Description
579
580 Color Color del flujo que esta pasando actualmente por el elemento (bomba
581  y tanque).
582 \layout Description
583
584 Capacidad\SpecialChar ~
585 Maxima Capacidad de almacenamiento de fluidos del elemento (tanque).
586 \layout Description
587
588 Contenido\SpecialChar ~
589 Inicial Cantidad de flujo almacenado inicialmente en el elemento
590  (tanque).
591 \layout Standard
592
593 La ventana de propiedades del tubo, el codo, el drenaje y el empalme son
594  practicamente iguales
595 \begin_inset Float figure
596 wide false
597 collapsed true
598
599 \layout Caption
600
601
602 \begin_inset LatexCommand \label{cap:Propiedades-del-Tubo}
603
604 \end_inset 
605
606 Propiedades del Tubo y Empalme.
607 \layout Standard
608 \align center 
609
610 \begin_inset Graphics
611         filename tubo_props.png
612         width 6cm
613         keepAspectRatio
614         subcaption
615         subcaptionText "Tubo"
616
617 \end_inset 
618
619  
620 \begin_inset Graphics
621         filename empalme_props.png
622         width 6cm
623         keepAspectRatio
624         subcaption
625         subcaptionText "Empalme"
626
627 \end_inset 
628
629
630 \end_inset 
631
632  (ver figura 
633 \begin_inset LatexCommand \ref{cap:Propiedades-del-Tubo}
634
635 \end_inset 
636
637 ), a este último elemento se le agrega la opción de seleccionar si es una
638  unión o una división, y el drenaje solo posee la propiedad Nombre.
639 \layout Standard
640
641 Para la bomba y el tanque aparecerán ventanas similares
642 \begin_inset Float figure
643 wide false
644 collapsed true
645
646 \layout Caption
647
648
649 \begin_inset LatexCommand \label{cap:Propiedades-del-Tanque}
650
651 \end_inset 
652
653 Propiedades del Tanque y la Bomba.
654 \layout Standard
655 \align center 
656
657 \begin_inset Graphics
658         filename tanque_props.png
659         width 7cm
660         keepAspectRatio
661         subcaption
662         subcaptionText "Tanque"
663
664 \end_inset 
665
666  
667 \begin_inset Graphics
668         filename bomba_props.png
669         width 7cm
670         keepAspectRatio
671         subcaption
672         subcaptionText "Bomba"
673
674 \end_inset 
675
676
677 \end_inset 
678
679  (ver figura 
680 \begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque}
681
682 \end_inset 
683
684 ), pero estos elementos tienen la capacidad de definir, además del nombre,
685  el color del fluido que almacenan o entregan.
686 \layout Standard
687
688 Al presionar el botón Color, se abrirá una nueva ventana de dialogo
689 \begin_inset Float figure
690 wide false
691 collapsed true
692
693 \layout Caption
694
695 Seleccion de color.
696 \layout Standard
697 \align center 
698
699 \begin_inset Graphics
700         filename color_dlg.png
701         width 12cm
702         keepAspectRatio
703
704 \end_inset 
705
706
707 \end_inset 
708
709  que permite seleccionar el mismo (ver figura 
710 \begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque}
711
712 \end_inset 
713
714 ).
715 \layout Standard
716
717 Las compuertas lógicas no tienen la capacidad de modificar sus propiedades.
718 \layout Subsection
719
720 Eliminar un elemento.
721 \layout Standard
722
723 Para eliminar un elemento puede utilizar la opción del menú 
724 \family sans 
725 Edición\SpecialChar \menuseparator
726 Borrar
727 \family default 
728  o hacer click con el botón derecho del puntero y seleccionar la opción
729  
730 \family sans 
731 Eliminar
732 \family default 
733  del menú contextual.
734  Además del elemento se eliminarán todas sus conexiones lógicas.
735 \layout Subsection
736
737 Mover un elemento.
738 \layout Standard
739
740 Puede mover un elemento arrastrandolo y soltándolo desde una ubicación del
741  
742 \family sans 
743 Área de trabajo
744 \family default 
745  a otra.
746 \layout Section
747
748 Diseño lógico de la planta.
749 \layout Standard
750
751 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.
752 \layout Standard
753
754 El agregado de las compuertas es tan simple como el de los demás elementos,
755  de la misma forma estas pueden rotar para acomodarse a las necesidades
756  del diseñador.
757 \layout Standard
758
759 Básicamente la conexión lógica se realiza en tres pasos:
760 \layout Subsection
761
762 Agregar compuertas logicas.
763 \layout Standard
764
765 Al igual que para agregar elemento comunes, para agregar compuertas logicas
766  basta con arrastrarlas y soltarlas en el 
767 \family sans 
768 Área de trabajo
769 \family default 
770
771 \begin_inset Float figure
772 wide false
773 collapsed true
774
775 \layout Caption
776
777
778 \begin_inset LatexCommand \label{cap:Agregar-compuertas-logicas.}
779
780 \end_inset 
781
782 Agregar compuertas logicas.
783 \layout Standard
784 \align center 
785
786 \begin_inset Graphics
787         filename conectando.png
788         lyxscale 70
789         width 14.7cm
790
791 \end_inset 
792
793
794 \end_inset 
795
796 .
797  En la figura 
798 \begin_inset LatexCommand \ref{cap:Agregar-compuertas-logicas.}
799
800 \end_inset 
801
802  puede ver un ejemplo.
803 \layout Subsection
804
805 Activar el modo de Logica.
806 \layout Standard
807
808 Para crear conexiones es necesario activar el modo de Lógica del 
809 \family sans 
810 Área de trabajo
811 \family default 
812 .
813  Esto se hace haciendo click en la caja de selección 
814 \family sans 
815 Lógica
816 \family default 
817  que se encuentra en la 
818 \family sans 
819 Barra de herramientas
820 \family default 
821 .
822 \layout Standard
823
824 Mientras este estado se encuentre activo, no se podrán realizar cambios
825  en las posiciones de los elementos, ni agregar nuevos, pero si podrán rotarse.
826 \layout Standard
827
828 Al mismo tiempo que se acciona la lógica, podran verse las zonas de conexion
829  de cada elemento que tenga una entrada o una salida (exclusas, tanques,
830  bombas y conectores logicos)
831 \begin_inset Float figure
832 wide false
833 collapsed false
834
835 \layout Caption
836
837
838 \begin_inset LatexCommand \label{cap:Modo-de-Logica.}
839
840 \end_inset 
841
842 Modo de Logica.
843 \layout Standard
844 \align center 
845
846 \begin_inset Graphics
847         filename logica.png
848         lyxscale 70
849         width 14.7cm
850
851 \end_inset 
852
853
854 \end_inset 
855
856 .
857  Las salidas se identifican con el color azul y las entradas con el rojo.
858  En la figura 
859 \begin_inset LatexCommand \ref{cap:Modo-de-Logica.}
860
861 \end_inset 
862
863  puede ver un ejemplo.
864 \layout Subsection
865
866 Conectar los elementos.
867 \layout Standard
868
869 Todas las conexiones deben hacerse desde una compuerta logica hacia otro
870  elemento (comun u otra compuerta logica).
871  Para seleccionar la compuerta logica desde la cual comenzar la conexión
872  simplemente haga click sobre la zona de conexión (entrada o salida).
873  A continuacion haga click en la zona de conexión del otro elmento y aparecera
874  una linea de color rojo o azul.
875  El azul indica una conexión entrante a la compuerta lógica y el rojo una
876  conexión saliente de la compuerta lógica.
877  Solo pueden hacerse conexiones desde la entrada de una compuerta lógica
878  (zona roja) a la salida de otro elemento (zona azul) o desde una salida
879  de una compuerta lógica (zona azul) a la entrada de otro elemento (zona
880  roja).
881 \layout Standard
882
883 Para conectar dos compuertas se debe clickear en primer lugar la salida
884  de la compuerta origen y en segunda instancia la entrada de la compuerta
885  destino.
886 \layout Standard
887
888 Las compuertas lógicas 
889 \family sans 
890 AND
891 \family default 
892  y 
893 \family sans 
894 OR
895 \family default 
896  pueden tener un número indefinido de entradas, mientras que la compuerta
897  
898 \family sans 
899 NOT
900 \family default 
901  puede debe tener solo una.
902  Todas las compuertas pueden tener una sola salida.
903  Los elementos de transporte de flujo con zonas de conexion aceptan un número
904  indefinido de conexiones.
905 \layout Standard
906
907 En la figura
908 \begin_inset LatexCommand \ref{cap:Planta_logica}
909
910 \end_inset 
911
912  se puede ver una planta terminada.
913 \begin_inset Float figure
914 wide false
915 collapsed true
916
917 \layout Caption
918
919
920 \begin_inset LatexCommand \label{cap:Planta_logica}
921
922 \end_inset 
923
924 Planta Completa
925 \begin_inset Graphics
926         filename planta_logica.png
927
928 \end_inset 
929
930
931 \end_inset 
932
933  
934 \the_end