Client/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 \begin_preamble
   5 \usepackage{graphicx}
   6 \newcommand{\myLogo}[2]{%
   7 \setlength{\unitlength}{1cm}
   8 \begin{picture}(0,0)
   9 \put(-8,+8.5){#1}% the logo for the left side
  10 %\put(8,+8.5){#1}% the logo for the right side
  11 \put(-7,9){\parbox[b]{5cm}{\Large \centering #2}}
  12 %\put(3,9){\parbox[b]{5cm}{\Large \centering #2}}% text for the rightside
  13 \end{picture}}
  14 \end_preamble
  15 \language spanish
  16 \inputencoding auto
  17 \fontscheme palatino
  18 \graphics default
  19 \float_placement !htb
  20 \paperfontsize default
  21 \spacing single
  22 \papersize a4paper
  23 \paperpackage widemarginsa4
  24 \use_geometry 0
  25 \use_amsmath 0
  26 \use_natbib 0
  27 \use_numerical_citations 0
  28 \paperorientation portrait
  29 \secnumdepth 3
  30 \tocdepth 3
  31 \paragraph_separation indent
  32 \defskip medskip
  33 \quotes_language english
  34 \quotes_times 2
  35 \papercolumns 1
  36 \papersides 2
  37 \paperpagestyle headings
  38
  39 \layout Standard
  40 \align center
  41
  42 \size huge
  43 PlaQui
  44 \size default
  45
  46 \size huge
  47 Client
  48 \size default
  49
  50 \newline
  51
  52 \size huge
  53 Manual de Usuario
  54 \layout Standard
  55
  56 \SpecialChar ~
  57
  58 \layout Standard
  59
  60 \SpecialChar ~
  61
  62 \layout Standard
  63
  64 \SpecialChar ~
  65
  66 \layout Standard
  67
  68 \SpecialChar ~
  69
  70 \layout Standard
  71
  72 \SpecialChar ~
  73
  74 \layout Standard
  75
  76 \SpecialChar ~
  77
  78 \layout Standard
  79 \align center
  80
  81 \begin_inset Graphics
  82         filename ../pixmaps/logo.png
  83
  84 \end_inset
  85
  86
  87 \layout Standard
  88
  89 \SpecialChar ~
  90
  91 \layout Standard
  92
  93 \SpecialChar ~
  94
  95 \layout Standard
  96
  97 \SpecialChar ~
  98
  99 \layout Standard
 100
 101 \SpecialChar ~
 102
 103 \layout Standard
 104
 105 \SpecialChar ~
 106
 107 \layout Standard
 108
 109 \SpecialChar ~
 110
 111 \layout Standard
 112 \align center
 113
 114 \size large
 115 Nicolás Dimov
 116 \newline
 117 Leandro Lucarella
 118 \newline
 119 Ricardo Markiewicz
 120 \layout Standard
 121
 122
 123 \begin_inset LatexCommand \tableofcontents{}
 124
 125 \end_inset
 126
 127
 128 \layout Chapter
 129
 130 Introducción.
 131 \layout Standard
 132
 133 PlaQui es un conjunto de aplicaciones para diseño, simulación y control
 134  de plantas químicas.
 135 \layout Standard
 136
 137 PlaQui Client es la aplicación para controlar y visualizar una planta química.
 138  Con este programa se puede ver la evolución en el tiempo de la planta y
 139  controlar los elemento que tengan alguna entrada.
 140 \layout Section
 141
 142 Abrir la aplicación.
 143 \layout Standard
 144
 145 Para abrir la aplicación basta con ejecutarla desde la línea de comandos.
 146  Escriba
 147 \family typewriter
 148 plaqui-client
 149 \family default
 150  y presione
 151 \family typewriter
 152 Enter
 153 \family default
 154 .
 155 \layout Subsection
 156
 157 Pantalla inicial.
 158 \layout Standard
 159
 160 Una vez abierta la aplicación aparecerá la ventana principal que se puede
 161  ver en la figura
 162 \begin_inset LatexCommand \vref{cap:Ventana-principal}
 163
 164 \end_inset
 165
 166 .
 167 \layout Standard
 168
 169
 170 \begin_inset Float figure
 171 wide false
 172 collapsed true
 173
 174 \layout Caption
 175
 176
 177 \begin_inset LatexCommand \label{cap:Ventana-principal}
 178
 179 \end_inset
 180
 181 Ventana principal de PlaQui Client.
 182 \layout Standard
 183 \align center
 184
 185 \begin_inset Graphics
 186         filename principal.png
 187         lyxscale 50
 188         width 14.7cm
 189         keepAspectRatio
 190
 191 \end_inset
 192
 193
 194 \end_inset
 195
 196
 197 \layout Standard
 198
 199 La ventana contiene los siguientes elementos:
 200 \layout Subsubsection
 201
 202 Barra de menú.
 203 \layout Standard
 204
 205 En la barra de menú se encuentra en la parte superior de la ventana y en
 206  ella están todas los comandos para trabajar con el programa.
 207 \layout Paragraph
 208
 209 Menú
 210 \family sans
 211 Archivo
 212 \family default
 213 .
 214 \layout Standard
 215
 216 En este menú se encuentran todos los comandos generales de la aplicación.
 217 \layout Standard
 218
 219
 220 \begin_inset Graphics
 221         filename conectar_m.png
 222         lyxscale 80
 223         scale 50
 224
 225 \end_inset
 226
 227
 228 \family sans
 229  Conectar
 230 \layout Standard
 231
 232 Abre una ventana de diálogo para conectarse al servidor.
 233 \layout Standard
 234
 235
 236 \begin_inset Graphics
 237         filename desconectar_m.png
 238         lyxscale 80
 239         scale 50
 240
 241 \end_inset
 242
 243
 244 \family sans
 245  Desconectar
 246 \layout Standard
 247
 248 Cierra la conexión con el servidor.
 249 \layout Standard
 250
 251
 252 \begin_inset Graphics
 253         filename quit.png
 254         lyxscale 70
 255         scale 40
 256         keepAspectRatio
 257
 258 \end_inset
 259
 260
 261 \family sans
 262  Salir
 263 \layout Standard
 264
 265 Sale del programa.
 266 \layout Paragraph
 267
 268 Menú
 269 \family sans
 270 Ver
 271 \family default
 272 .
 273 \layout Standard
 274
 275 En este menú se encuentran los comandos para modificar la forma de visualizar
 276  la planta.
 277 \layout Standard
 278
 279
 280 \begin_inset Graphics
 281         filename properties.png
 282         lyxscale 70
 283         scale 40
 284
 285 \end_inset
 286
 287
 288 \family sans
 289  Propiedades
 290 \layout Standard
 291
 292 Abre una ventana de diálogo para modificar las propiedades de la planta.
 293 \layout Paragraph
 294
 295 Menú
 296 \family sans
 297 Ver
 298 \family default
 299 .
 300 \layout Standard
 301
 302 En este menú se encuentran los comandos para controlar el servidor.
 303 \layout Standard
 304
 305
 306 \begin_inset Graphics
 307         filename detener_servidor.png
 308         lyxscale 70
 309         scale 40
 310
 311 \end_inset
 312
 313
 314 \family sans
 315  Detener Servidor
 316 \layout Standard
 317
 318 Detiene el servidor.
 319  Debe tener cuidado al utilizar esta opcion porque cierra el servidor inmediatam
 320 ente, si hay otros clientes serán desconectados.
 321 \layout Paragraph
 322
 323 Menú
 324 \family sans
 325 Ayuda
 326 \family default
 327 .
 328 \layout Standard
 329
 330 En este menú se encuentran los comandos para obtener ayuda.
 331 \layout Description
 332
 333 Acerca Obtiene información acerca de la aplicación.
 334 \layout Subsubsection
 335
 336 Barra de herramientas.
 337 \layout Standard
 338
 339 La barra de herramientas
 340 \begin_inset Float figure
 341 wide false
 342 collapsed false
 343
 344 \layout Caption
 345
 346
 347 \begin_inset LatexCommand \label{cap:Barra-de-herramientas.}
 348
 349 \end_inset
 350
 351 Barra de herramientas.
 352 \layout Standard
 353 \align center
 354
 355 \begin_inset Graphics
 356         filename barra_herramientas.png
 357         width 11cm
 358
 359 \end_inset
 360
 361
 362 \end_inset
 363
 364  se encuentra debajo de la
 365 \family sans
 366 Barra de menú
 367 \family default
 368  (ver figura
 369 \begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
 370
 371 \end_inset
 372
 373 ).
 374  Tiene los comandos mas frecuentemente utilizados.
 375 \layout Standard
 376
 377
 378 \begin_inset Graphics
 379         filename conectar.png
 380         lyxscale 40
 381         scale 20
 382
 383 \end_inset
 384
 385
 386 \family sans
 387  Conectar
 388 \layout Standard
 389
 390 Se conecta a un servidor.
 391 \layout Standard
 392
 393
 394 \begin_inset Graphics
 395         filename simular.png
 396         lyxscale 40
 397         scale 20
 398
 399 \end_inset
 400
 401
 402 \family sans
 403  Simular
 404 \layout Standard
 405
 406 Comienza o reanuda la simulación del servidor.
 407 \layout Standard
 408
 409
 410 \begin_inset Graphics
 411         filename pausar.png
 412         lyxscale 40
 413         scale 20
 414
 415 \end_inset
 416
 417
 418 \family sans
 419  Pausar
 420 \layout Standard
 421
 422 Detiene momentáneamente la simulación del servidor.
 423 \layout Standard
 424
 425 En el extremo derecho de la barra hay un
 426 \family sans
 427 Indicador de conexión
 428 \family default
 429  que informa si el cliente esta conectado
 430 \begin_inset Graphics
 431         filename conectar_m.png
 432         lyxscale 80
 433         scale 50
 434
 435 \end_inset
 436
 437  o desconectado
 438 \begin_inset Graphics
 439         filename desconectar_m.png
 440         lyxscale 80
 441         scale 50
 442
 443 \end_inset
 444
 445 .
 446 \layout Subsubsection
 447
 448 Barra de información.
 449 \layout Standard
 450
 451 Es la barra que se encuentra a la derecha de la ventana principal y esta
 452  dividida en dos.
 453  En la parte superior se indica el estado del elemento seleccionado actualmente,
 454  en la parte inferior se encuentra una animación que indica si se están
 455  recibiendo datos del servidor.
 456  Si la animación esta detenida pueden haber pasado 3 cosas:
 457 \layout Itemize
 458
 459 Pudo haberse perdido la conexión con el servidor.
 460  En este caso el
 461 \family sans
 462 Indicador de conexión
 463 \family default
 464  estará en rojo.
 465 \layout Itemize
 466
 467 La simulación puede estar pausada.
 468  Pruebe presionando el icono para
 469 \family sans
 470 Simular
 471 \family default
 472 .
 473 \layout Itemize
 474
 475 Puede haber un problema de red, por el cual no está llegando el estado de
 476  la planta.
 477 \layout Subsubsection
 478
 479 Barra de estado.
 480 \layout Standard
 481
 482 Es el área de texto que se encuentra en la parte inferior de la ventana
 483  principal.
 484  Informa sobre el estado de la conexión y las respuestas del servidor.
 485 \layout Subsubsection
 486
 487 Área de visualización.
 488 \layout Standard
 489
 490 Es el espacio central, en el se muestra la planta que se esta controlando.
 491 \layout Section
 492
 493 Iniciar y terminar una conexión.
 494 \layout Subsection
 495
 496 Iniciar la conexión.
 497 \layout Standard
 498
 499 Para inicial la conexión con un servidor hay dos formas: desde el menú
 500 \family sans
 501 Archivo\SpecialChar \menuseparator
 502 Conectar
 503 \family default
 504  o presionando sobre el icono
 505 \begin_inset Graphics
 506         filename conectar.png
 507         lyxscale 40
 508         scale 20
 509
 510 \end_inset
 511
 512  de la
 513 \family sans
 514 Barra de herramientas
 515 \family default
 516 .
 517  En ambos casos se abrirá una ventana de diálogo
 518 \begin_inset Float figure
 519 wide false
 520 collapsed true
 521
 522 \layout Caption
 523
 524
 525 \begin_inset LatexCommand \label{cap:Ventana-de-diálogo}
 526
 527 \end_inset
 528
 529 Ventana de diálogo para conectarse al servidor.
 530 \layout Standard
 531 \align center
 532
 533 \begin_inset Graphics
 534         filename dialogo_conectar.png
 535         width 5cm
 536
 537 \end_inset
 538
 539
 540 \end_inset
 541
 542  (figura
 543 \begin_inset LatexCommand \vref{cap:Ventana-de-diálogo}
 544
 545 \end_inset
 546
 547 ) en la que puede seleccionar el
 548 \emph on
 549 host
 550 \emph default
 551  y el puerto del servidor al cual conectarse.
 552  Una vez ingresados los datos, presione
 553 \family sans
 554 Aceptar
 555 \family default
 556 .
 557  La planta servida aparecerá en el
 558 \family sans
 559 Área de visualización
 560 \family default
 561 .
 562 \layout Standard
 563
 564 Si la conexión fue exitosa verá que el indicador de conexión de la
 565 \family sans
 566 Barra de herramientas
 567 \family default
 568  se pondrá verde y aparecerá un mensaje en la
 569 \family sans
 570 Barra de estado
 571 \family default
 572 .
 573 \layout Subsection
 574
 575 Terminar la conexión.
 576 \layout Standard
 577
 578 Para finalizar la conexión debe seleccionar la opción del menú
 579 \family sans
 580 Archivo\SpecialChar \menuseparator
 581 Desconectar
 582 \family default
 583 .
 584 \layout Section
 585
 586 Empezar, pausar y cambiar parámetros de la simulación.
 587 \layout Subsection
 588
 589
 590 \begin_inset LatexCommand \label{sub:Empezar-la-simulacion.}
 591
 592 \end_inset
 593
 594 Empezar la simulación.
 595 \layout Standard
 596
 597 Para empezar la simulación debe hacer click sobre el icono
 598 \family sans
 599 Simular
 600 \family default
 601  de la
 602 \family sans
 603 Barra de Herramientas
 604 \family default
 605 .
 606  A partir de ahora verá que la planta empieza a evolucionar en el tiempo.
 607  La animación
 608 \begin_inset Float figure
 609 wide false
 610 collapsed true
 611
 612 \layout Caption
 613
 614
 615 \begin_inset LatexCommand \label{cap:Simulación-en-curso.}
 616
 617 \end_inset
 618
 619 Simulación en curso.
 620 \layout Standard
 621 \align center
 622
 623 \begin_inset Graphics
 624         filename simulando.png
 625         lyxscale 50
 626         width 14.7cm
 627
 628 \end_inset
 629
 630
 631 \end_inset
 632
 633  de la
 634 \family sans
 635 Barra de Información
 636 \family default
 637  le servirá para saber que la planta está en funcionamiento.
 638  En la figura
 639 \begin_inset LatexCommand \ref{cap:Simulación-en-curso.}
 640
 641 \end_inset
 642
 643  puede ver un ejemplo.
 644 \layout Subsection
 645
 646 Pausar la simulación.
 647 \layout Standard
 648
 649 Para pausar la simulación debe hacer click sobre el icono
 650 \family sans
 651 Pausar
 652 \family default
 653  de la
 654 \family sans
 655 Barra de Herramientas
 656 \family default
 657 .
 658  A partir de ahora verá que la planta se queda en el estado actual y no
 659  cambia en el tiempo
 660 \begin_inset Float figure
 661 wide false
 662 collapsed true
 663
 664 \layout Caption
 665
 666
 667 \begin_inset LatexCommand \label{cap:Simulación-en-pausa.}
 668
 669 \end_inset
 670
 671 Simulación en pausa.
 672 \layout Standard
 673 \align center
 674
 675 \begin_inset Graphics
 676         filename conectado_pausa.png
 677         lyxscale 50
 678         width 14.7cm
 679
 680 \end_inset
 681
 682
 683 \end_inset
 684
 685  como se ve en la figura
 686 \begin_inset LatexCommand \ref{cap:Simulación-en-pausa.}
 687
 688 \end_inset
 689
 690 .
 691  La animación de la
 692 \family sans
 693 Barra de Información
 694 \family default
 695  se detendrá también.
 696 \layout Subsection
 697
 698 Reanudar la simulación.
 699 \layout Standard
 700
 701 Para reanudar la simulación basta con seguir los pasos de
 702 \begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
 703
 704 \end_inset
 705
 706 .
 707 \layout Subsection
 708
 709 Cambiar parámetros de simulación.
 710 \layout Standard
 711
 712 Para cambiar los parámetros de la simulación debe seleccionar la opcion
 713  del menú
 714 \family sans
 715 Ver\SpecialChar \menuseparator
 716 Propiedades
 717 \family default
 718 .
 719  Se abrirá una ventana de diálogo en donde puede elegir la velocidad de
 720  la simulación (o tiempo de refresco).
 721  Puede ingresar en el campo la cantidad de veces por segundo que cambiará
 722  de estado la planta y luego presionar
 723 \family sans
 724 Aceptar
 725 \family default
 726  para que el servidor tome los cambios.
 727 \layout Section
 728
 729 Salir del programa.
 730 \layout Standard
 731
 732 Para salir del programa puede presionar sobre la cruz que generalmente se
 733  encuentra en la esquina superior derecha de la ventana principal (esto
 734  depende de su manejador de ventanas) o desde el menú
 735 \family sans
 736 Archivo\SpecialChar \menuseparator
 737 Salir
 738 \family default
 739 .
 740 \layout Chapter
 741
 742 Controlar una planta.
 743 \layout Standard
 744
 745 El proceso de control de una planta es simple porque el estado se ve en
 746  tiempo real en el
 747 \family sans
 748 Área de visualización
 749 \family default
 750 .
 751  Para poder observar cada elemento detenidamente sin sufrir cambios es posible
 752  detener la planta por un tiempo y después volver a reanudarla.
 753 \layout Section
 754
 755 Ver el estado de la planta.
 756 \layout Standard
 757
 758 El estado de la planta puede verse en forma global ya que sobre cada elemento
 759  se ve el color del liquido que fluye, si por ese elemento hay flujo en
 760  ese instante.
 761  Puede verse también a simple vista el estado de los circuitos lógicos,
 762  cuyos cables son coloreados según su estado.
 763  Los cables azules representan un estado bajo (0 o falso) y los cables rojos
 764  un estado alto (1 o verdadero).
 765 \layout Subsection
 766
 767 Ver estado detallado de un elemento.
 768 \layout Standard
 769
 770 Para ver el estado detallado de un elemento primero debe seleccionarlo en
 771  el
 772 \family sans
 773 Área de trabajo
 774 \family default
 775  haciendo click sobre él.
 776  En la parte de
 777 \family sans
 778 Propiedades
 779 \family default
 780  de la
 781 \family sans
 782 Barra de información
 783 \family default
 784  aparecerán todos detalles de dicho elemento.
 785 \layout Subsubsection
 786
 787 Propiedades.
 788 \layout Standard
 789
 790 Las propiedades de los elementos mostradas son las siguientes (entre paréntesis
 791  se indica que elementos tienen dicha propiedad):
 792 \layout Description
 793
 794 Nombre Nombre del elemento (todos).
 795 \layout Description
 796
 797 Color Color del flujo que esta pasando actualmente por el elemento (todos).
 798 \layout Description
 799
 800 Flujo\SpecialChar ~
 801 Actual Indica el flujo que esta pasando actualmente por el elemento
 802  (todos menos tanque).
 803 \layout Description
 804
 805 Estado Estado del elemento: Abierto o Cerrado (exclusa), Encendida o Apagada
 806  (bomba)
 807 \layout Description
 808
 809 Capacidad Capacidad de almacenamiento de fluidos del elemento (tanque).
 810 \layout Description
 811
 812 Liquido Cantidad de flujo almacenado actualmente en el elemento (tanque).
 813 \layout Subsection
 814
 815 Modificar estado de un elemento.
 816 \layout Standard
 817
 818 Para modificar el estado un elemento primero debe seleccionarlo en el
 819 \family sans
 820 Área de trabajo
 821 \family default
 822  haciendo click sobre él.
 823  En la parte inferior de
 824 \family sans
 825 Propiedades
 826 \family default
 827  de la
 828 \family sans
 829 Barra de información
 830 \family default
 831  hay un botón
 832 \family sans
 833 On/Off
 834 \family default
 835  que puede utilizarse para encender o apagar una bomba y abrir o cerrar
 836  una exclusa.
 837  Solo se puede cambiar el estado de bombas y exclusas.
 838 \the_end