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