]> git.llucax.com Git - z.facultad/75.42/plaqui.git/blob - Constructor/doc/manual.lyx
subo el workplace.h y decime si asi esta bien puesto el comentario
[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 true
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 Comment
350
351 ACA ESTARIA BUENO PONER UNA IMAGEN DE TODA LA PANTALLA INDICANDO QUE ES
352  CADA COSA
353 \layout Comment
354
355 ( DENTRO DE LA MISMA IMAGEN)
356 \layout Section
357
358 Guardar y recuperar el trabajo.
359 \layout Subsection
360
361 Abrir un archivo de planta.
362 \layout Standard
363
364 Para abrir un archivo tiene dos formas: desde el menú 
365 \family sans 
366 Archivo\SpecialChar \menuseparator
367 Abrir
368 \family default 
369  o presionando sobre el ícono 
370 \begin_inset Graphics
371         filename open.png
372
373 \end_inset 
374
375  de la 
376 \family sans 
377 Barra de herramientas
378 \family default 
379 .
380  En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar
381  el archivo a abrir.
382  Una vez seleccionado, presione 
383 \family sans 
384 Aceptar
385 \family default 
386 .
387  La planta aparecerá en la ventana principal.
388 \layout Subsection
389
390 Guardar un archivo de planta.
391 \layout Standard
392
393 De manera similar a la carga o apertura de una planta, se puede guardar
394  o salvar la misma.
395  Para esto también hay dos formas distintas:
396 \family sans 
397  Archivo\SpecialChar \menuseparator
398 Salvar
399 \family default 
400  o presionando sobre el ícono 
401 \family sans 
402 Salvar
403 \family default 
404  de la barra de herramientas.
405 \layout Standard
406
407 La primera vez que el archivo sea guardado, se abrirá un diálogo para selecciona
408 r la ubicación donde desee guardarse, luego al presionar el botón en la
409  barra de herramientas que realiza esta acción, se sobreescribirá el archivo.
410 \layout Standard
411
412 Si se desea guardar el archivo con otro nombre o en otra ubicación, siempre
413  estará disponible la primera opción, que en todos los casos mostrará el
414  diálogo correspondiente.
415 \layout Standard
416
417 Para poder guardar un archivo de planta, esta debe estar correctamente conectada
418 , esto puede verificarse presionando el botón de la barra de herramientas
419  
420 \begin_inset Quotes eld
421 \end_inset 
422
423 Verificar Conexionado
424 \begin_inset Quotes erd
425 \end_inset 
426
427  el cual desplegará un diálogo de error, indicamdo cual es el elemento que
428  no verifica, si no se cumple la condición o un diálogo de éxito si todo
429  es correcto.
430 \layout Subsection
431
432 Empezar una planta nueva.
433 \layout Standard
434
435 Para comenzar a editar una planta nueva debe presionarse el botón en el
436  menú principal 
437 \family sans 
438 Archivo\SpecialChar \menuseparator
439 Nuevo 
440 \family default 
441 o directamente desde el acceso rápido en la barra de herramientas presionando
442  el botón con el mismo ícono, que se encuentra en la primera posición.
443 \layout Standard
444
445 Luego de este procedimiento, si el usuario desea guardar nuevamente el trabajo,
446  volverá a aparecer el diálogo para seleccionar la ubicación y nombre del
447  archivo por primera vez.
448 \layout Section
449
450 Salir del programa.
451 \layout Standard
452
453 Para salir del programa puede presionar sobre la cruz que generalmente se
454  encuentra en la esquina superior derecha de la ventana principal (esto
455  depende de su manejador de ventanas) o desde el menú 
456 \family sans 
457 Archivo\SpecialChar \menuseparator
458 Salir
459 \family default 
460 .
461 \layout Chapter
462
463 Crear una planta.
464 \layout Standard
465
466 Para crear una planta sólo tiene que arrastrar y soltar los elementos en
467  el área de trabajo.
468  Una vez conseguido el diseño físico de la planta puede empezar a arrastrar
469  y soltar compuertas lógicas para definir su comportamiento dinámico.
470  Finalmente, para hacer el conexionado lógico debe activar la caja de selección
471  
472 \family sans 
473 Lógica
474 \family default 
475  de la barra de herramientas.
476 \layout Standard
477
478 A continuación se detalla el proceso.
479 \layout Section
480
481 Diseño Físico de la planta.
482 \layout Subsection
483
484 Agregar un elemento.
485 \layout Standard
486
487 Para agregar un elemento hay que arrastrarlo y soltarlo desde la 
488 \family sans 
489 Barra de elementos
490 \family default 
491  al 
492 \family sans 
493 Área de trabajo
494 \family default 
495 .
496 \layout Subsection
497
498 Modificar un elemento.
499 \layout Standard
500
501 Para modificar un elemento primero debe seleccionarlo en el 
502 \family sans 
503 Área de trabajo
504 \family default 
505  y luego realizar alguna de las siguientes acciones:
506 \layout Subsubsection
507
508 Orientar un elemento.
509 \layout Standard
510
511 Para cambiar la orientación de un elemento puede hacer click con el botón
512  central del puntero o hacer click con el botón derecho y seleccionar la
513  opción 
514 \family sans 
515 Rotar
516 \family default 
517  del menú contextual.
518  Según el tipo de elemento puede ser que rote o se 
519 \emph on 
520 espeje
521 \emph default 
522 .
523 \layout Subsubsection
524
525 Cambiar las propiedades de un elemento.
526 \layout Standard
527
528 Para modificar las propiedades de un elemento puede hacer doble-click sobre
529  el mismo o haciendo click con el botón derecho del puntero y seleccionando
530  la opción 
531 \family sans 
532 Propiedades
533 \family default 
534  del menú contextual.
535  Esto abre una ventana de diálogo que, según el tipo de elemento le permitirá
536  cambiar las siguiente propiedades:
537 \layout Description
538
539 Nombre Nombre e identificador unico del elemento (todos).
540 \layout Description
541
542 Flujo\SpecialChar ~
543 Maximo Indica el flujo maximo que puede pasar por el elemento (tubo,
544  codo, empalme y bomba).
545 \layout Description
546
547 Estado Estado del elemento: Abierto o Cerrado (exclusa).
548 \layout Description
549
550 Tipo\SpecialChar ~
551 de\SpecialChar ~
552 Conexion Define como se comporta el elemento: Union o Division (empalme).
553 \layout Description
554
555 Color Color del flujo que esta pasando actualmente por el elemento (bomba
556  y tanque).
557 \layout Description
558
559 Capacidad\SpecialChar ~
560 Maxima Capacidad de almacenamiento de fluidos del elemento (tanque).
561 \layout Description
562
563 Contenido\SpecialChar ~
564 Inicial Cantidad de flujo almacenado inicialmente en el elemento
565  (tanque).
566 \layout Standard
567
568 La ventana de propiedades del tubo, el codo, el drenaje y el empalme son
569  practicamente iguales
570 \begin_inset Float figure
571 wide false
572 collapsed false
573
574 \layout Caption
575
576
577 \begin_inset LatexCommand \label{cap:Propiedades-del-Tubo}
578
579 \end_inset 
580
581 Propiedades del Tubo y Empalme.
582 \layout Standard
583 \align center 
584
585 \begin_inset Graphics
586         filename tubo_props.png
587         width 6cm
588         keepAspectRatio
589         subcaption
590         subcaptionText "Tubo"
591
592 \end_inset 
593
594  
595 \begin_inset Graphics
596         filename empalme_props.png
597         width 6cm
598         keepAspectRatio
599         subcaption
600         subcaptionText "Empalme"
601
602 \end_inset 
603
604
605 \end_inset 
606
607  (ver figura 
608 \begin_inset LatexCommand \ref{cap:Propiedades-del-Tubo}
609
610 \end_inset 
611
612 ), a este último elemento se le agrega la opción de seleccionar si es una
613  unión o una división, y el drenaje solo posee la propiedad Nombre.
614 \layout Standard
615
616 Para la bomba y el tanque aparecerán ventanas similares
617 \begin_inset Float figure
618 wide false
619 collapsed false
620
621 \layout Caption
622
623
624 \begin_inset LatexCommand \label{cap:Propiedades-del-Tanque}
625
626 \end_inset 
627
628 Propiedades del Tanque y la Bomba.
629 \layout Standard
630 \align center 
631
632 \begin_inset Graphics
633         filename tanque_props.png
634         width 7cm
635         keepAspectRatio
636         subcaption
637         subcaptionText "Tanque"
638
639 \end_inset 
640
641  
642 \begin_inset Graphics
643         filename bomba_props.png
644         width 7cm
645         keepAspectRatio
646         subcaption
647         subcaptionText "Bomba"
648
649 \end_inset 
650
651
652 \end_inset 
653
654  (ver figura 
655 \begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque}
656
657 \end_inset 
658
659 ), pero estos elementos tienen la capacidad de definir, además del nombre,
660  el color del fluido que almacenan o entregan.
661 \layout Standard
662
663 Al presionar el botón Color, se abrirá una nueva ventana de dialogo
664 \begin_inset Float figure
665 wide false
666 collapsed true
667
668 \layout Caption
669
670 Seleccion de color.
671 \layout Standard
672 \align center 
673
674 \begin_inset Graphics
675         filename color_dlg.png
676         width 12cm
677         keepAspectRatio
678
679 \end_inset 
680
681
682 \end_inset 
683
684  que permite seleccionar el mismo (ver figura 
685 \begin_inset LatexCommand \ref{cap:Propiedades-del-Tanque}
686
687 \end_inset 
688
689 ).
690 \layout Standard
691
692 Las compuertas lógicas no tienen la capacidad de modificar sus propiedades.
693 \layout Subsection
694
695 Eliminar un elemento.
696 \layout Standard
697
698 Para eliminar un elemento puede utilizar la opción del menú 
699 \family sans 
700 Edición\SpecialChar \menuseparator
701 Borrar
702 \family default 
703  o hacer click con el botón derecho del puntero y seleccionar la opción
704  
705 \family sans 
706 Eliminar
707 \family default 
708  del menú contextual.
709  Además del elemento se eliminarán todas sus conexiones lógicas.
710 \layout Subsection
711
712 Mover un elemento.
713 \layout Standard
714
715 Puede mover un elemento arrastrandolo y soltándolo desde una ubicación del
716  
717 \family sans 
718 Área de trabajo
719 \family default 
720  a otra.
721 \layout Section
722
723 Diseño lógico de la planta.
724 \layout Standard
725
726 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.
727 \layout Standard
728
729 El agregado de las compuertas es tan simple como el de los demás elementos,
730  de la misma forma estas pueden rotar para acomodarse a las necesidades
731  del diseñador.
732 \layout Standard
733
734 Básicamente la conexión lógica se realiza en tres pasos:
735 \layout Subsection
736
737 Agregar compuertas logicas.
738 \layout Standard
739
740 Al igual que para agregar elemento comunes, para agregar compuertas logicas
741  basta con arrastrarlas y soltarlas en el 
742 \family sans 
743 Área de trabajo
744 \family default 
745
746 \begin_inset Float figure
747 wide false
748 collapsed true
749
750 \layout Caption
751
752
753 \begin_inset LatexCommand \label{cap:Agregar-compuertas-logicas.}
754
755 \end_inset 
756
757 Agregar compuertas logicas.
758 \layout Standard
759 \align center 
760
761 \begin_inset Graphics
762         filename conectando.png
763         lyxscale 70
764         width 14.7cm
765
766 \end_inset 
767
768
769 \end_inset 
770
771 .
772  En la figura 
773 \begin_inset LatexCommand \ref{cap:Agregar-compuertas-logicas.}
774
775 \end_inset 
776
777  puede ver un ejemplo.
778 \layout Subsection
779
780 Activar el modo de Logica.
781 \layout Standard
782
783 Para crear conexiones es necesario activar el modo de Lógica del 
784 \family sans 
785 Área de trabajo
786 \family default 
787 .
788  Esto se hace haciendo click en la caja de selección 
789 \family sans 
790 Lógica
791 \family default 
792  que se encuentra en la 
793 \family sans 
794 Barra de herramientas
795 \family default 
796 .
797 \layout Standard
798
799 Mientras este estado se encuentre activo, no se podrán realizar cambios
800  en las posiciones de los elementos, ni agregar nuevos, pero si podrán rotarse.
801 \layout Standard
802
803 Al mismo tiempo que se acciona la lógica, podran verse las zonas de conexion
804  de cada elemento que tenga una entrada o una salida (exclusas, tanques,
805  bombas y conectores logicos)
806 \begin_inset Float figure
807 wide false
808 collapsed true
809
810 \layout Caption
811
812
813 \begin_inset LatexCommand \label{cap:Modo-de-Logica.}
814
815 \end_inset 
816
817 Modo de Logica.
818 \layout Standard
819 \align center 
820
821 \begin_inset Graphics
822         filename logica.png
823         lyxscale 70
824         width 14.7cm
825
826 \end_inset 
827
828
829 \end_inset 
830
831 .
832  Las salidas se identifican con el color azul y las entradas con el rojo.
833  En la figura 
834 \begin_inset LatexCommand \ref{cap:Modo-de-Logica.}
835
836 \end_inset 
837
838  puede ver un ejemplo.
839 \layout Subsection
840
841 Conectar los elementos.
842 \layout Standard
843
844 Todas las conexiones deben hacerse desde una compuerta logica hacia otro
845  elemento (comun u otra compuerta logica).
846  Para seleccionar la compuerta logica desde la cual comenzar la conexion
847  simplemente haga click sobre la zona de conexion (entrada o salida).
848  A continuacion haga click en la zona de conexion del otro elmento y aparecera
849  una linea de color rojo o azul.
850  El azul indica una conexion entrante a la compuerta logica y el rojo una
851  conexion saliente de la compuerta logica.
852  Solo pueden hacerse conexiones desde la entrada de una compuerta logica
853  (zona roja) a la salida de otro elemento (zona azul) o desde una salida
854  de una compuerta logica (zona azul) a la entrada de otro elemento (zona
855  roja).
856 \layout Standard
857
858 Las compuertas lógicas 
859 \family sans 
860 AND
861 \family default 
862  y 
863 \family sans 
864 OR
865 \family default 
866  pueden tener un número indefinido de entradas, mientras que la compuerta
867  
868 \family sans 
869 NOT
870 \family default 
871  puede debe tener solo una.
872  Todas las compuertas pueden tener una sola salida.
873  Los elementos comunes con zonas de conexion aceptan un numero indefinido
874  de conexiones.
875 \the_end