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