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 false
  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
 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 Description
 138
 139
 140 \begin_inset Graphics
 141         filename conectar.png
 142
 143 \end_inset
 144
 145 Conectar Abre una ventana de diálogo para conectarse al servidor.
 146 \layout Description
 147
 148
 149 \begin_inset Graphics
 150         filename desconectar.png
 151
 152 \end_inset
 153
 154 Desconectar Cierra la conexión con el servidor.
 155 \layout Description
 156
 157
 158 \begin_inset Graphics
 159         filename quit.png
 160         lyxscale 80
 161         scale 80
 162         keepAspectRatio
 163
 164 \end_inset
 165
 166 Salir Sale del programa.
 167 \layout Paragraph
 168
 169 Menú
 170 \family sans
 171 Ver
 172 \family default
 173 .
 174 \layout Standard
 175
 176 En este menú se encuentran los comandos para modificar la forma de visualizar
 177  la planta.
 178 \layout Description
 179
 180
 181 \begin_inset Graphics
 182         filename properties.png
 183
 184 \end_inset
 185
 186 Propiedades Abre una ventana de diálogo para modificar las propiedades de
 187  la planta.
 188 \layout Paragraph
 189
 190 Menú
 191 \family sans
 192 Ver
 193 \family default
 194 .
 195 \layout Standard
 196
 197 En este menú se encuentran los comandos para controlar el servidor.
 198 \layout Description
 199
 200
 201 \begin_inset Graphics
 202         filename detener_servidor.png
 203
 204 \end_inset
 205
 206 Detener\SpecialChar ~
 207 Servidor Detiene el servidor.
 208  Debe tener cuidado al utilizar esta opcion porque cierra el servidor inmediatam
 209 ente, si hay otros clientes serán desconectados.
 210 \layout Paragraph
 211
 212 Menú
 213 \family sans
 214 Ayuda
 215 \family default
 216 .
 217 \layout Standard
 218
 219 En este menú se encuentran los comandos para obtener ayuda.
 220 \layout Description
 221
 222 Acerca Obtiene información acerca de la aplicación.
 223 \layout Subsubsection
 224
 225 Barra de herramientas.
 226 \layout Standard
 227
 228 La barra de herramientas
 229 \begin_inset Float figure
 230 wide false
 231 collapsed true
 232
 233 \layout Caption
 234
 235
 236 \begin_inset LatexCommand \label{cap:Barra-de-herramientas.}
 237
 238 \end_inset
 239
 240 Barra de herramientas.
 241 \layout Standard
 242 \align center
 243
 244 \begin_inset Graphics
 245         filename barra_herramientas.png
 246
 247 \end_inset
 248
 249
 250 \end_inset
 251
 252  se encuentra debajo de la
 253 \family sans
 254 Barra de menú
 255 \family default
 256  (ver figura
 257 \begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
 258
 259 \end_inset
 260
 261 ).
 262  Tiene los comandos mas frecuentemente utilizados.
 263 \layout Description
 264
 265
 266 \begin_inset Graphics
 267         filename conectar.png
 268
 269 \end_inset
 270
 271 Conectar Se conecta a un servidor.
 272 \layout Description
 273
 274
 275 \begin_inset Graphics
 276         filename simular.png
 277
 278 \end_inset
 279
 280 Simular Comienza o reanuda la simulación del servidor.
 281 \layout Description
 282
 283
 284 \begin_inset Graphics
 285         filename pausar.png
 286
 287 \end_inset
 288
 289 Pausar Detiene momentáneamente la simulación del servidor.
 290 \layout Standard
 291
 292 En el extremo derecho de la barra hay un
 293 \family sans
 294 Indicador de conexión
 295 \family default
 296  que informa si el cliente esta conectado (verde) o desconectado (rojo).
 297 \layout Subsubsection
 298
 299 Barra de información.
 300 \layout Standard
 301
 302 Es la barra que se encuentra a la derecha de la ventana principal y esta
 303  dividida en dos.
 304  En la parte superior se indica el estado del elemento seleccionado actualmente,
 305  en la parte inferior se encuentra una animación que indica si se están
 306  recibiendo datos del servidor.
 307  Si la animación esta detenida pueden haber pasado 3 cosas:
 308 \layout Itemize
 309
 310 Pudo haberse perdido la conexión con el servidor.
 311  En este caso el
 312 \family sans
 313 Indicador de conexión
 314 \family default
 315  estará en rojo.
 316 \layout Itemize
 317
 318 La simulación puede estar pausada.
 319  Pruebe presionando el icono para
 320 \family sans
 321 Simular
 322 \family default
 323 .
 324 \layout Itemize
 325
 326 Puede haber un problema de red, por el cual no está llegando el estado de
 327  la planta.
 328 \layout Subsubsection
 329
 330 Barra de estado.
 331 \layout Standard
 332
 333 Es el área de texto que se encuentra en la parte inferior de la ventana
 334  principal.
 335  Informa sobre el estado de la conexión y las respuestas del servidor.
 336 \layout Subsubsection
 337
 338 Área de visualización.
 339 \layout Standard
 340
 341 Es el espacio central, en el se muestra la planta que se esta controlando.
 342 \layout Section
 343
 344 Iniciar y terminar una conexión.
 345 \layout Subsection
 346
 347 Iniciar la conexión.
 348 \layout Standard
 349
 350 Para inicial la conexión con un servidor hay dos formas: desde el menú
 351 \family sans
 352 Archivo\SpecialChar \menuseparator
 353 Conectar
 354 \family default
 355  o presionando sobre el icono
 356 \begin_inset Graphics
 357         filename conectar.png
 358
 359 \end_inset
 360
 361  de la
 362 \family sans
 363 Barra de herramientas
 364 \family default
 365 .
 366  En ambos casos se abrirá una ventana de diálogo en la que puede seleccionar
 367  el
 368 \emph on
 369 host
 370 \emph default
 371  y el puerto del servidor al cual conectarse.
 372  Una vez ingresados los datos, presione
 373 \family sans
 374 Aceptar
 375 \family default
 376 .
 377  La planta servida aparecerá en el
 378 \family sans
 379 Área de visualización
 380 \family default
 381 .
 382 \layout Standard
 383
 384 Si la conexión fue exitosa verá que el indicador de conexión de la
 385 \family sans
 386 Barra de herramientas
 387 \family default
 388  se pondrá verde y aparecerá un mensaje en la
 389 \family sans
 390 Barra de estado
 391 \family default
 392 .
 393 \layout Subsection
 394
 395 Terminar la conexión.
 396 \layout Standard
 397
 398 Para finalizar la conexión debe seleccionar la opción del menú
 399 \family sans
 400 Archivo\SpecialChar \menuseparator
 401 Desconectar
 402 \family default
 403 .
 404 \layout Section
 405
 406 Empezar, pausar y cambiar parámetros de la simulación.
 407 \layout Subsection
 408
 409
 410 \begin_inset LatexCommand \label{sub:Empezar-la-simulacion.}
 411
 412 \end_inset
 413
 414 Empezar la simulación.
 415 \layout Standard
 416
 417 Para empezar la simulación debe hacer click sobre el icono
 418 \family sans
 419 Simular
 420 \family default
 421  de la
 422 \family sans
 423 Barra de Herramientas
 424 \family default
 425 .
 426  A partir de ahora verá que la planta empieza a evolucionar en el tiempo.
 427  La animación de la
 428 \family sans
 429 Barra de Información
 430 \family default
 431  le servirá para saber que la planta está en funcionamiento.
 432 \layout Subsection
 433
 434 Pausar la simulación.
 435 \layout Standard
 436
 437 Para pausar la simulación debe hacer click sobre el icono
 438 \family sans
 439 Pausar
 440 \family default
 441  de la
 442 \family sans
 443 Barra de Herramientas
 444 \family default
 445 .
 446  A partir de ahora verá que la planta se queda en el estado actual y no
 447  cambia en el tiempo.
 448  La animación de la
 449 \family sans
 450 Barra de Información
 451 \family default
 452  se detendrá también.
 453 \layout Subsection
 454
 455 Reanudar la simulación.
 456 \layout Standard
 457
 458 Para reanudar la simulación basta con seguir los pasos de
 459 \begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
 460
 461 \end_inset
 462
 463 .
 464 \layout Subsection
 465
 466 Cambiar parámetros de simulación.
 467 \layout Standard
 468
 469 Para cambiar los parámetros de la simulación debe seleccionar la opcion
 470  del menú
 471 \family sans
 472 Ver\SpecialChar \menuseparator
 473 Propiedades
 474 \family default
 475 .
 476  Se abrirá una ventana de diálogo en donde puede elegir la velocidad de
 477  la simulación (o tiempo de refresco).
 478  Puede ingresar en el campo la cantidad de veces por segundo que cambiará
 479  de estado la planta y luego presionar
 480 \family sans
 481 Aceptar
 482 \family default
 483  para que el servidor tome los cambios.
 484 \layout Section
 485
 486 Salir del programa.
 487 \layout Standard
 488
 489 Para salir del programa puede presionar sobre la cruz que generalmente se
 490  encuentra en la esquina superior derecha de la ventana principal (esto
 491  depende de su manejador de ventanas) o desde el menú
 492 \family sans
 493 Archivo\SpecialChar \menuseparator
 494 Salir
 495 \family default
 496 .
 497 \layout Chapter
 498
 499 Controlar una planta.
 500 \layout Standard
 501
 502 El proceso de control de una planta es simple porque el estado se ve en
 503  tiempo real en el
 504 \family sans
 505 Área de visualización
 506 \family default
 507 .
 508  Para poder observar cada elemento detenidamente sin sufrir cambios es posible
 509  detener la planta por un tiempo y después volver a reanudarla.
 510 \layout Section
 511
 512 Ver el estado de la planta.
 513 \layout Standard
 514
 515 El estado de la planta puede verse en forma global ya que sobre cada elemento
 516  se ve el color del liquido que fluye, si por ese elemento hay flujo en
 517  ese instante.
 518  Puede verse también a simple vista el estado de los circuitos lógicos,
 519  cuyos cables son coloreados según su estado.
 520  Los cables azules representan un estado bajo (0 o falso) y los cables rojos
 521  un estado alto (1 o verdadero).
 522 \layout Subsection
 523
 524 Ver estado detallado de un elemento.
 525 \layout Standard
 526
 527 Para ver el estado detallado de un elemento primero debe seleccionarlo en
 528  el
 529 \family sans
 530 Área de trabajo
 531 \family default
 532  haciendo click sobre él.
 533  En la parte de
 534 \family sans
 535 Propiedades
 536 \family default
 537  de la
 538 \family sans
 539 Barra de información
 540 \family default
 541  aparecerán todos detalles de dicho elemento.
 542 \layout Subsubsection
 543
 544 Propiedades.
 545 \layout Standard
 546
 547 Las propiedades de los elementos mostradas son las siguientes (entre paréntesis
 548  se indica que elementos tienen dicha propiedad):
 549 \layout Description
 550
 551 Nombre Nombre del elemento (todos).
 552 \layout Description
 553
 554 Color Color del flujo que esta pasando actualmente por el elemento (todos).
 555 \layout Description
 556
 557 Flujo\SpecialChar ~
 558 Actual Indica el flujo que esta pasando actualmente por el elemento
 559  (todos menos tanque).
 560 \layout Description
 561
 562 Estado Estado del elemento: Abierto o Cerrado (exclusa), Encendida o Apagada
 563  (bomba)
 564 \layout Description
 565
 566 Capacidad Capacidad de almacenamiento de fluidos del elemento (tanque).
 567 \layout Description
 568
 569 Liquido Cantidad de flujo almacenado actualmente en el elemento (tanque).
 570 \layout Subsection
 571
 572 Modificar estado de un elemento.
 573 \layout Standard
 574
 575 Para modificar el estado un elemento primero debe seleccionarlo en el
 576 \family sans
 577 Área de trabajo
 578 \family default
 579  haciendo click sobre él.
 580  En la parte inferior de
 581 \family sans
 582 Propiedades
 583 \family default
 584  de la
 585 \family sans
 586 Barra de información
 587 \family default
 588  hay un botón
 589 \family sans
 590 On/Off
 591 \family default
 592  que puede utilizarse para encender o apagar una bomba y abrir o cerrar
 593  una exclusa.
 594  Solo se puede cambiar el estado de bombas y exclusas.
 595 \the_end