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                         /// Nombre del archivo donde esta el XML de la planta.
  66                         std::string filename;
  67
  68
  69                 // Métodos.
  70
  71                 protected:
  72
  73                         /**
  74                          * Corre la planta (la monitorea o la simula).
  75                          */
  76                         virtual void real_run(void);
  77
  78                 public:
  79
  80                         /**
  81                          * Destructor.
  82                          */
  83                         virtual ~Plant(void);
  84
  85                         /**
  86                          * Constructor desde un archivo.
  87                          *
  88                          * \param name     Nombre de la planta.
  89                          * \param filename Nombre del archivo de donde obtener la planta.
  90                          */
  91                         Plant(const std::string& filename);
  92
  93                         /**
  94                          * Comienza una transmisión del estado de la planta.
  95                          *
  96                          * \return true si comenzó la transmisión, false si hubo problemas.
  97                          */
  98                         bool transmission_start(string& host, Connection::Port& port);
  99
 100                         /**
 101                          * Comienza una transmisión del estado de la planta.
 102                          *
 103                          * \return true si detuvo la transmisión, false si no existía.
 104                          */
 105                         bool transmission_stop(const string& host,
 106                                         const Connection::Port& port);
 107
 108                         /**
 109                          * Obtiene el XML de la planta.
 110                          */
 111                         const std::string get_xml(void) const;
 112
 113         };
 114
 115 }
 116
 117 }
 118
 119 #endif // PLAQUI_PLANT_H