Server/include/plaqui/server/plant.h

   1 // vim: set noexpandtab tabstop=4 shiftwidth=4:
   2 //----------------------------------------------------------------------------
   3 //                                  PlaQui
   4 //----------------------------------------------------------------------------
   5 // This file is part of PlaQui.
   6 //
   7 // PlaQui is free software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the Free Software
   9 // Foundation; either version 2 of the License, or (at your option) any later
  10 // version.
  11 //
  12 // PlaQui is distributed in the hope that it will be useful, but WITHOUT ANY
  13 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15 // details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with PlaQui; if not, write to the Free Software Foundation, Inc., 59 Temple
  19 // Place, Suite 330, Boston, MA  02111-1307  USA
  20 //----------------------------------------------------------------------------
  21 // Creado:  sáb nov 15 17:29:44 ART 2003
  22 // Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23 //----------------------------------------------------------------------------
  24 //
  25 // $Id$
  26 //
  27
  28 #ifndef PLAQUI_PLANT_H
  29 #define PLAQUI_PLANT_H
  30
  31 #include "plaqui/server/runnable.h"
  32 #include "plaqui/server/transmitter.h"
  33 #include "simulator.h"
  34 #include <sigc++/signal.h>
  35
  36 namespace PlaQui {
  37
  38 namespace Server {
  39
  40         /// Planta Química.
  41         class Plant: public Runnable {
  42
  43
  44                 // Tipos.
  45
  46                 private:
  47
  48                         /// Lista de conexiones de control.
  49                         typedef std::list<Transmitter*> TransmitterList;
  50
  51
  52                 // Atributos.
  53
  54                 private:
  55
  56                         /// Transmisiones del estado de las plantas.
  57                         TransmitterList transmissions;
  58
  59                         /// Mutex para las transmisiones.
  60                         Glib::Mutex transmissions_mutex;
  61
  62                         /// Simulador usado para calcular el estado de la planta.
  63                         Model::Simulator simulator;
  64
  65                         /// Mutex para el simulador.
  66                         Glib::Mutex simulator_mutex;
  67
  68                         /// Nombre del archivo donde esta el XML de la planta.
  69                         std::string filename;
  70
  71
  72                 // Métodos.
  73
  74                 protected:
  75
  76                         /**
  77                          * Corre la planta (la monitorea o la simula).
  78                          */
  79                         virtual void real_run(void);
  80
  81                 public:
  82
  83                         /**
  84                          * Destructor.
  85                          */
  86                         virtual ~Plant(void);
  87
  88                         /**
  89                          * Constructor desde un archivo.
  90                          *
  91                          * \param filename Nombre del archivo de donde obtener la planta.
  92                          */
  93                         Plant(const std::string& filename);
  94
  95                         /**
  96                          * Comienza una transmisión del estado de la planta.
  97                          *
  98                          * \return true si comenzó la transmisión, false si hubo problemas.
  99                          */
 100                         bool transmission_start(string& host, Connection::Port& port);
 101
 102                         /**
 103                          * Comienza una transmisión del estado de la planta.
 104                          *
 105                          * \return true si detuvo la transmisión, false si no existía.
 106                          */
 107                         bool transmission_stop(const string& host,
 108                                         const Connection::Port& port);
 109
 110                         /**
 111                          * Borra una transmisión de la lista de transmisiones al finalizar.
 112                          *
 113                          * \param transmission Transmisión a eliminar.
 114                          */
 115                         bool on_transmission_finished(Transmitter* transmission);
 116
 117                         /**
 118                          * Abre (o cierra) un elemento de la planta.
 119                          *
 120                          * Sólo la bomba y la exclusa pueden ser abiertos y cerrados.
 121                          *
 122                          * \param element Nombre del elemento a abrir o cerrar.
 123                          * \param open    true si se quiere abrir el elemento, false si se
 124                          *                lo quiere cerrar.
 125                          *
 126                          * \return true si se abrió o cerró el elemento, false si no existía
 127                          *         o si no era una bomba o exclusa.
 128                          */
 129                         bool set_open(const std::string& element, bool open = true);
 130
 131                         /**
 132                          * Obtiene el XML de la planta.
 133                          */
 134                         const std::string get_xml(void) const;
 135
 136         };
 137
 138 }
 139
 140 }
 141
 142 #endif // PLAQUI_PLANT_H