Se actualiza documentacion:

[z.facultad/75.42/plaqui.git] / Server / include / plaqui / server / plant.h

diff --git a/Server/include/plaqui/server/plant.h b/Server/include/plaqui/server/plant.h
index c6e64a6c5fcc7442ddef79531773257d57b6414b..02109090defdcafc8ef3713c548d8058633abdaf 100644 (file)
--- a/Server/include/plaqui/server/plant.h
+++ b/Server/include/plaqui/server/plant.h
@@ -40,7 +40,15 @@ namespace Server {
        /// Planta Química.
        class Plant: public Runnable {
 
        /// Planta Química.
        class Plant: public Runnable {
 

+               /////////////////////////////////////////////////////////////////////
+               // Constantes.

 
 

+               private:
+
+                       /// Tiempo por defecto a esperar entre iteraciones de la simulación.
+                       static const unsigned DEFAULT_WAIT_TIME = 300000u; // 0,3 segundos
+
+               /////////////////////////////////////////////////////////////////////

                // Tipos.
 
                private:
                // Tipos.
 
                private:


@@ -48,7 +56,7 @@ namespace Server {
                        /// Lista de conexiones de control.
                        typedef std::list<Transmitter*> TransmitterList;
 
                        /// Lista de conexiones de control.
                        typedef std::list<Transmitter*> TransmitterList;
 

-
+               /////////////////////////////////////////////////////////////////////

                // Atributos.
 
                private:
                // Atributos.
 
                private:


@@ -62,10 +70,25 @@ namespace Server {
                        /// Simulador usado para calcular el estado de la planta.
                        Model::Simulator simulator;
 
                        /// Simulador usado para calcular el estado de la planta.
                        Model::Simulator simulator;
 

+                       /// Mutex para el simulador.
+                       Glib::Mutex simulator_mutex;
+

                        /// Nombre del archivo donde esta el XML de la planta.
                        std::string filename;
 
                        /// Nombre del archivo donde esta el XML de la planta.
                        std::string filename;
 

+                       /// Tiempo que espera entre cada iteración de la simulación.
+                       unsigned wait_time;
+
+                       /// Mutex para el tiempo de espera.
+                       Glib::Mutex wait_time_mutex;
+
+                       /// Indica si la planta está pausada o simulando.
+                       bool paused;

 
 

+                       /// Mutex para el indicador de pausa.
+                       Glib::Mutex paused_mutex;
+
+               /////////////////////////////////////////////////////////////////////

                // Métodos.
 
                protected:
                // Métodos.
 
                protected:


@@ -73,7 +96,7 @@ namespace Server {
                        /**
                         * Corre la planta (la monitorea o la simula).
                         */
                        /**
                         * Corre la planta (la monitorea o la simula).
                         */

-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();

 
                public:
 
 
                public:
 


@@ -85,7 +108,6 @@ namespace Server {
                        /**
                         * Constructor desde un archivo.
                         *
                        /**
                         * Constructor desde un archivo.
                         *

-                        * \param name     Nombre de la planta.

                         * \param filename Nombre del archivo de donde obtener la planta.
                         */
                        Plant(const std::string& filename);
                         * \param filename Nombre del archivo de donde obtener la planta.
                         */
                        Plant(const std::string& filename);


@@ -105,6 +127,43 @@ namespace Server {
                        bool transmission_stop(const string& host,
                                        const Connection::Port& port);
 
                        bool transmission_stop(const string& host,
                                        const Connection::Port& port);
 

+                       /**
+                        * Borra una transmisión de la lista de transmisiones al finalizar.
+                        *
+                        * \param transmission Transmisión a eliminar.
+                        */
+                       void on_transmission_finished(Transmitter* transmission);
+
+                       /**
+                        * Abre (o cierra) un elemento de la planta.
+                        *
+                        * Sólo la bomba y la exclusa pueden ser abiertos y cerrados.
+                        *
+                        * \param element Nombre del elemento a abrir o cerrar.
+                        * \param open    true si se quiere abrir el elemento, false si se
+                        *                lo quiere cerrar.
+                        *
+                        * \return true si se abrió o cerró el elemento, false si no existía
+                        *         o si no era una bomba o exclusa.
+                        */
+                       bool set_open(const std::string& element, bool open = true);
+
+                       /**
+                        * Setea la frecuencia de refresco de la simulación.
+                        * Si se setea a cero, se usa el tiempo por omisión.
+                        *
+                        * \param hz Cantidad de veces por segundo que debe refrescarse la
+                        *           simulación.
+                        */
+                       void set_frequency(unsigned hz = 0u);
+
+                       /**
+                        * Pausa (o reanuda) la simulación.
+                        *
+                        * \param paused true si se la quiere pausar, false para reanudar.
+                        */
+                       void set_paused(bool paused = true);
+

                        /**
                         * Obtiene el XML de la planta.
                         */
                        /**
                         * Obtiene el XML de la planta.
                         */