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 que se puede
  82  ver en la figura
  83 \begin_inset LatexCommand \vref{cap:Ventana-principal}
  84
  85 \end_inset
  86
  87 .
  88 \layout Standard
  89
  90
  91 \begin_inset Float figure
  92 wide false
  93 collapsed true
  94
  95 \layout Caption
  96
  97
  98 \begin_inset LatexCommand \label{cap:Ventana-principal}
  99
 100 \end_inset
 101
 102 Ventana principal de PlaQui Constructor
 103 \layout Standard
 104
 105
 106 \begin_inset Graphics
 107         filename /home/nico/plaqui/Constructor/doc/principal.png
 108         lyxscale 50
 109         width 14.7cm
 110         keepAspectRatio
 111
 112 \end_inset
 113
 114
 115 \end_inset
 116
 117
 118 \layout Standard
 119
 120 La ventana contiene los siguientes elementos:
 121 \layout Subsubsection
 122
 123 Barra de menú.
 124 \layout Standard
 125
 126 En la barra de menú se encuentra en la parte superior de la ventana y en
 127  ella están todas los comandos para trabajar con el programa.
 128 \layout Paragraph
 129
 130 Menú
 131 \family sans
 132 Archivo
 133 \family default
 134 .
 135 \layout Standard
 136
 137 En este menú se encuentran todos los comandos para manejar archivos y salir
 138  del programa.
 139 \layout Description
 140
 141
 142 \begin_inset Graphics
 143         filename /home/nico/plaqui/Constructor/doc/new.png
 144
 145 \end_inset
 146
 147 Nuevo Empieza a construir una planta nueva.
 148  La planta con la que estaba trabajando actualmente será descartada.
 149 \layout Description
 150
 151
 152 \begin_inset Graphics
 153         filename /home/nico/plaqui/Constructor/doc/open.png
 154
 155 \end_inset
 156
 157 Abrir Abre una planta nueva.
 158  La planta con la que estaba trabajando actualmente será descartada.
 159 \layout Description
 160
 161
 162 \begin_inset Graphics
 163         filename /home/nico/plaqui/Constructor/doc/save.png
 164
 165 \end_inset
 166
 167 Guardar Guarda la planta actual.
 168 \layout Description
 169
 170
 171 \begin_inset Graphics
 172         filename /home/nico/plaqui/Constructor/doc/quit.png
 173
 174 \end_inset
 175
 176 Salir Sale del programa.
 177  La planta con la que estaba trabajando actualmente será descartada.
 178 \layout Paragraph
 179
 180 Menú
 181 \family sans
 182 Edición
 183 \family default
 184 .
 185 \layout Standard
 186
 187 En este menú se encuentran los comandos para trabajar con los elementos
 188  de la planta.
 189 \layout Description
 190
 191
 192 \begin_inset Graphics
 193         filename /home/nico/plaqui/Constructor/doc/delete.png
 194
 195 \end_inset
 196
 197 Borrar Borra el elemento seleccionado actualmente.
 198 \layout Description
 199
 200
 201 \begin_inset Graphics
 202         filename /home/nico/plaqui/Constructor/doc/clear.png
 203
 204 \end_inset
 205
 206 Borrar\SpecialChar ~
 207 Todo Borra todos los elementos de la planta.
 208  Es equivalente a
 209 \family sans
 210 Archivo\SpecialChar \menuseparator
 211 Nuevo
 212 \family default
 213 .
 214 \layout Paragraph
 215
 216 Menú
 217 \family sans
 218 Ayuda
 219 \family default
 220 .
 221 \layout Standard
 222
 223 En este menú se encuentran los comandos para obtener ayuda.
 224 \layout Description
 225
 226 Acerca Obtiene información acerca de la aplicación.
 227 \layout Subsubsection
 228
 229 Barra de herramientas.
 230 \layout Standard
 231
 232
 233 \begin_inset Graphics
 234         filename barra_herramientas.png
 235
 236 \end_inset
 237
 238
 239 \layout Standard
 240
 241 En la barra de herramientas se encuentra debajo de la
 242 \family sans
 243 Barra de menú
 244 \family default
 245  y está dividida en dos.
 246  En la parte superior se encuentran íconos para ejecutar los comandos (del
 247  menú principal) más comunes del programa, como empezar una planta nueva,
 248  guardar la planta actual y abrir una planta existente.
 249 \layout Standard
 250
 251 En la parte inferior se encuentran herramientas adicionales útiles a la
 252  hora de trabajar con la planta.
 253 \layout Standard
 254
 255
 256 \series bold
 257 Verificar Conexionado
 258 \series default
 259 Verifica que todos los elementos estén conectados, y formen un circuito
 260  de manera que pudierda fluir un líquido.
 261 \layout Standard
 262
 263
 264 \series bold
 265 Lista
 266 \series default
 267  Ubicada en la segunda posición de la barra, indica cuál fué el último elemento
 268  seleccionado mediante un click del mouse, y almacena todos los nombres
 269  de los elementos que fueron seleccionados.
 270 \layout Standard
 271
 272
 273 \series bold
 274 Buscar
 275 \series default
 276  Marca con un recuadro negro el elemento seleccionado (el que aparece en
 277  la lista).
 278 \layout Standard
 279
 280
 281 \begin_inset Graphics
 282         filename buscar.png
 283
 284 \end_inset
 285
 286
 287 \layout Subsubsection
 288
 289 Barra de elementos de planta.
 290 \layout Standard
 291
 292 En la barra de íconos que se encuentra a la izquierda.
 293  En ella están todos los elementos (físicos) que pueden ser incluídos en
 294  una planta.
 295 \layout Subsubsection
 296
 297 Barra de compuertas lógicas.
 298 \layout Standard
 299
 300 En la barra de íconos que se encuentra a la derecha.
 301  En esta barra se encuentran las compuertas lógicas para diseñar el comportamien
 302 to dinámico de la planta.
 303  Las compuertas son AND, OR y NOT.
 304 \layout Subsubsection
 305
 306 Barra de estado.
 307 \layout Standard
 308
 309 Esta barra se encuentra en la parte inferior de la ventana principal y proporcio
 310 na información adicional útil a la hora de trabajar con una planta, como
 311  las propiedades del elemento seleccionado.
 312 \layout Subsubsection
 313
 314 Área de trabajo.
 315 \layout Standard
 316
 317 Es el espacio grillado central, en ella se arrastran y sueltan los elementos
 318  de una planta para su diseño.
 319 \layout Comment
 320
 321 ACA ESTARIA BUENO PONER UNA IMAGEN DE TODA LA PANTALLA INDICANDO QUE ES
 322  CADA COSA
 323 \layout Comment
 324
 325 ( DENTRO DE LA MISMA IMAGEN)
 326 \layout Section
 327
 328 Guardar y recuperar el trabajo.
 329 \layout Subsection
 330
 331 Abrir un archivo de planta.
 332 \layout Standard
 333
 334 Para abrir un archivo tiene dos formas: desde el menú
 335 \family sans
 336 Archivo\SpecialChar \menuseparator
 337 Abrir
 338 \family default
 339  o presionando sobre el ícono
 340 \family sans
 341 Abrir
 342 \family default
 343  de la barra de herramientas.
 344  En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar
 345  el archivo a abrir.
 346  Una vez seleccionado, presione
 347 \family sans
 348 Aceptar
 349 \family default
 350 .
 351  La planta aparecerá en la ventana principal.
 352 \layout Subsection
 353
 354 Guardar un archivo de planta.
 355 \layout Standard
 356
 357 De manera similar a la carga o apertura de una planta, se puede guardar
 358  o salvar la misma.
 359  Para esto también hay dos formas distintas:
 360 \family sans
 361  Archivo\SpecialChar \menuseparator
 362 Salvar
 363 \family default
 364  o presionando sobre el ícono
 365 \family sans
 366 Salvar
 367 \family default
 368  de la barra de herramientas.
 369 \layout Standard
 370
 371 La primera vez que el archivo sea guardado, se abrirá un diálogo para selecciona
 372 r la ubicación donde desee guardarse, luego al presionar el botón en la
 373  barra de herramientas que realiza esta acción, se sobreescribirá el archivo.
 374 \layout Standard
 375
 376 Si se desea guardar el archivo con otro nombre o en otra ubicación, siempre
 377  estará disponible la primera opción, que en todos los casos mostrará el
 378  diálogo correspondiente.
 379 \layout Standard
 380
 381 Para poder guardar un archivo de planta, esta debe estar correctamente conectada
 382 , esto puede verificarse presionando el botón de la barra de herramientas
 383
 384 \begin_inset Quotes eld
 385 \end_inset
 386
 387 Verificar Conexionado
 388 \begin_inset Quotes erd
 389 \end_inset
 390
 391  el cual desplegará un diálogo de error, indicamdo cual es el elemento que
 392  no verifica, si no se cumple la condición o un diálogo de éxito si todo
 393  es correcto.
 394 \layout Subsection
 395
 396 Empezar una planta nueva.
 397 \layout Standard
 398
 399 Para comenzar a editar una planta nueva debe presionarse el botón en el
 400  menú principal
 401 \family sans
 402 Archivo\SpecialChar \menuseparator
 403 Nuevo
 404 \family default
 405 o directamente desde el acceso rápido en la barra de herramientas presionando
 406  el botón con el mismo ícono, que se encuentra en la primera posición.
 407 \layout Standard
 408
 409 Luego de este procedimiento, si el usuario desea guardar nuevamente el trabajo,
 410  volverá a aparecer el diálogo para seleccionar la ubicación y nombre del
 411  archivo por primera vez.
 412 \layout Section
 413
 414 Salir del programa.
 415 \layout Standard
 416
 417 Para salir del programa puede presionar sobre la cruz que generalmente se
 418  encuentra en la esquina superior derecha de la ventana principal (esto
 419  depende de su manejador de ventanas) o desde el menú
 420 \family sans
 421 Archivo\SpecialChar \menuseparator
 422 Salir
 423 \family default
 424 .
 425 \layout Chapter
 426
 427 Crear una planta.
 428 \layout Standard
 429
 430 Para crear una planta sólo tiene que arrastrar y soltar los elementos en
 431  el área de trabajo.
 432  Una vez conseguido el diseño físico de la planta puede empezar a arrastrar
 433  y soltar compuertas lógicas para definir su comportamiento dinámico.
 434  Finalmente, para hacer el conexionado lógico debe activar la caja de selección
 435
 436 \family sans
 437 Lógica
 438 \family default
 439  de la barra de herramientas.
 440 \layout Standard
 441
 442 A continuación se detalla el proceso.
 443 \layout Section
 444
 445 Diseño Físico de la planta.
 446 \layout Subsection
 447
 448 Agregar un elemento.
 449 \layout Standard
 450
 451 Para agregar un elemento hay que arrastrarlo y soltarlo desde la
 452 \family sans
 453 Barra de elementos
 454 \family default
 455  al
 456 \family sans
 457 Área de trabajo
 458 \family default
 459 .
 460 \layout Subsection
 461
 462 Modificar un elemento.
 463 \layout Standard
 464
 465 Para modificar un elemento primero debe seleccionarlo en el
 466 \family sans
 467 Área de trabajo
 468 \family default
 469  y luego realizar alguna de las siguientes acciones:
 470 \layout Subsubsection
 471
 472 Orientar un elemento.
 473 \layout Standard
 474
 475 Para cambiar la orientación de un elemento puede hacer click con el botón
 476  central del puntero o hacer click con el botón derecho y seleccionar la
 477  opción
 478 \family sans
 479 Rotar
 480 \family default
 481  del menú contextual.
 482  Según el tipo de elemento puede ser que rote o se
 483 \emph on
 484 espeje
 485 \emph default
 486 .
 487 \layout Subsubsection
 488
 489 Cambiar las propiedades de un elemento.
 490 \layout Standard
 491
 492 Para modificar las propiedades de un elemento puede hacer doble-click sobre
 493  el mismo.
 494  Esto abre una ventana de diálogo que, según el tipo de elemento le permitirá
 495  cambiar las siguiente propiedades:
 496 \layout Description
 497
 498 Nombre Nombre del elemento.
 499  Este nombre se utiliza para identificar este elemento para poder controlarlo
 500  desde la aplicación de control.
 501 \layout Description
 502
 503 La ventana de propiedades del tubo, el codo, el drenaje y el empalme son
 504  practicamente iguales, a este último elemento se le agrega la opción de
 505  seleccionar si es una unión o una división, y el drenaje solo posee la
 506  propiedad Nombre.
 507 \layout Description
 508
 509
 510 \begin_inset Graphics
 511         filename tubo_props.png
 512
 513 \end_inset
 514
 515
 516 \begin_inset Graphics
 517         filename empalme_props.png
 518
 519 \end_inset
 520
 521
 522 \layout Description
 523
 524 Para la bomba y el tanque aparecerán ventanas similares, pero estos elementos
 525  tienen la capacidad de definir, además del nombre, el color del fluido
 526  que almacenan o entregan.
 527 \layout Description
 528
 529
 530 \begin_inset Graphics
 531         filename tanque_props.png
 532
 533 \end_inset
 534
 535
 536 \begin_inset Graphics
 537         filename bomba_props.png
 538
 539 \end_inset
 540
 541
 542 \layout Description
 543
 544 Al presionar el botón Color, se abrirá un nuevo diálogo que permite seleccionar
 545  el mismo.
 546 \layout Description
 547
 548
 549 \begin_inset Graphics
 550         filename color_dlg.png
 551
 552 \end_inset
 553
 554
 555 \layout Description
 556
 557 Las compuertas lógicas no tienen la capacidad de modificar sus propiedades.
 558 \layout Standard
 559
 560 La ventana de diálogo de propiedades también puede abrirse haciendo click
 561  con el botón derecho del puntero y seleccionando la opción
 562 \family sans
 563 Propiedades
 564 \family default
 565  del menú contextual.
 566 \layout Subsection
 567
 568 Eliminar un elemento.
 569 \layout Standard
 570
 571 Para eliminar un elemento puede utilizar la opción del menú
 572 \family sans
 573 Edición\SpecialChar \menuseparator
 574 Borrar
 575 \family default
 576  o hacer click con el botón derecho del puntero y seleccionar la opción
 577
 578 \family sans
 579 Eliminar
 580 \family default
 581  del menú contextual.
 582  Además del elemento se eliminarán todas sus conexiones lógicas.
 583 \layout Subsection
 584
 585 Mover un elemento.
 586 \layout Standard
 587
 588 Puede mover un elemento arrastrandolo y soltándolo desde una ubicación del
 589
 590 \family sans
 591 Área de trabajo
 592 \family default
 593  a otra.
 594 \layout Section
 595
 596 Diseño lógico de la planta.
 597 \layout Standard
 598
 599 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.
 600 \layout Standard
 601
 602 El agregado de las compuertas es tan simple como el de los demás elementos,
 603  de la misma forma estas pueden rotar para acomodarse a las necesidades
 604  del diseñador.
 605 \layout Standard
 606
 607 Básicamente la conexión lógica se realiza en tres pasos:
 608 \layout Standard
 609
 610
 611 \series bold
 612 1.
 613  Agregado de compuertas.
 614 \layout Standard
 615
 616 Como bien se menciono anteriormente, deben arrastrarse las compuertas hasta
 617  el área de trabajo (grilla).
 618 \layout Standard
 619
 620
 621 \begin_inset Graphics
 622         filename conectando.png
 623
 624 \end_inset
 625
 626
 627 \layout Standard
 628
 629
 630 \series bold
 631 2.Pasar al estado Lógico de diseño.
 632 \layout Standard
 633
 634 Esto se hace clickeando en la caja de selección
 635 \begin_inset Quotes eld
 636 \end_inset
 637
 638 Lógica
 639 \begin_inset Quotes erd
 640 \end_inset
 641
 642  que se encuentra en la barra de herramientas.
 643 \layout Standard
 644
 645 Cuando este estado este seleccionado, no se podrán realizar cambios en las
 646  posiciones de los elementos, ni agregar nuevos, pero si podrán rotarse.
 647 \layout Standard
 648
 649 Al mismo tiempo que se acciona la lógica, todos los elemento que puedan
 650  ser conectados
 651 \begin_inset Quotes eld
 652 \end_inset
 653
 654 iluminaran
 655 \begin_inset Quotes erd
 656 \end_inset
 657
 658  sus conectores lógicos, es decir, se dibujarán en ROJO los conectores que
 659  representan entradas, y en AZUL los que representen SALIDAS.
 660 \layout Standard
 661
 662 No todos los items tienen conectores lógicos, por lo tanto, al pasar a este
 663  estado, solo se iluminaran los conectores en la exclusa, la bomba, y el
 664  tanque.
 665  El usuario notará que el tanque posee dos conectores azules, esto se debe
 666  a que posee dos salidas.
 667 \layout Standard
 668
 669
 670 \begin_inset Graphics
 671         filename logica.png
 672
 673 \end_inset
 674
 675
 676 \layout Standard
 677
 678
 679 \series bold
 680 3.Conectar los elementos.
 681 \layout Standard
 682
 683 La finalidad de este paso es simular una conexión lógica entre los elementos
 684  de la planta, esto es, conectando mediante líneas los mismos, las cuales
 685  podrían representar cables.
 686 \layout Standard
 687
 688 Es importante destacar que una salida SIEMPRE debe estar conectada con una
 689  entrada.
 690  Es por eso que el conector ROJO de un elemento se conecta solo con un conector
 691  AZUL de otro.
 692 \layout Subsection
 693
 694 Conectando elementos.
 695 \layout Standard
 696
 697 Luego de realizados los tres pasos mencionados en el punto anterior, esta
 698  todo listo para comenzar a conectar elementos.
 699 \layout Standard
 700
 701 Las conexiones se realizan siempre desde una compuerta hacia un elemento,
 702  o de compuerta a compuerta.
 703 \layout Standard
 704
 705 Para conectar dos elementos primero hay que realizar un click en la entrada/sali
 706 da de una compuerta, y luego en la salida/entrada de otro elemento de la
 707  planta, siempre respentando la convención de que una entrada se une con
 708  una salida.
 709 \layout Standard
 710
 711 Las compuertas lógicas AND y OR pueden tener un número indefinido de entradas,
 712  no así la NOT que debe tener solo una.
 713 \layout Standard
 714
 715 Todas las compuertas pueden tener solo una salida.
 716 \layout Standard
 717
 718 En los conectores lógicos de los elementos que no son compuertas, pueden
 719  conectarse cualquier cantidad de cables.
 720 \the_end