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