]> git.llucax.com Git - z.facultad/75.42/plaqui.git/blob - Model/include/plantitem.h
Agrego un pedorro manual de usuario :-)
[z.facultad/75.42/plaqui.git] / Model / include / plantitem.h
1
2
3 #ifndef _ELEMENTO_PLANTA_H_
4 #define _ELEMENTO_PLANTA_H_
5
6 #include <string>
7 #include "iconector.h"
8 #include "rgb.h"
9 #include <sstream>
10
11 namespace PlaQui {
12
13 namespace Model {
14
15 /** Elementos simulables en una planta
16  *
17  *  Todo elemento que pueda ser simulado en la planta debe
18  *  descender de esta clase.
19  */
20 class PlantItem:public IConector {
21 public:
22         /** Constructor
23          *
24          *  \param _name Nombre único que identifica el objeto
25          */
26         PlantItem(const std::string &_name);
27         /// FIXME : agregar el nombre!
28         PlantItem(unsigned ins, unsigned outs);
29         /// Destructor
30         virtual ~PlantItem();
31
32         // FIXME: ver que parametros seran necesarios
33         // TODO : ver si no son inutiles!!!
34         virtual void send_fluid() {}
35         virtual void receive_fluid() {}
36
37         /** Ejecuta la fase de actualización.
38          *
39          *  Durante la fase de actualización los objetos se comunican entre
40          *  sí para determinar cual es el flujo que manejan en una iteración.
41          */
42         virtual void update(int dir=OUT) = 0;
43         /** Hace la simulación de esta iteración
44          *
45          *  Por simulacion se entiende que el modelo debe avisar a las vistas
46          *  que ya está actualizado para que el usuario vea los resultados.
47          */
48         virtual void simulate() = 0;
49
50         /// Setea el nuevo color del fluido
51         void set_color(const RGB &c) { fluid_color = c; }
52         /// Retorna el actual color del fluido
53         const RGB &get_color() { return fluid_color; }
54
55         /** Recive un mensage y lo procesa
56          *  
57          *  \see IConector::recieve_msg
58          */
59         virtual void recieve_msg(int msg, IConector *who, void *data);
60
61         /// Mensages manejados por los elementos de la planta
62         enum {
63                 MSG_QUERY_MAX_FLOW_OUT = IConector::MSG_LAST, ///< flujo maximo a la salida
64                 MSG_QUERY_MAX_FLOW_IN, ///< flujo maximo a la entrada
65                 MSG_RESPONSE_MAX_FLOW, ///< responde al mensage QUERY_MAX_FLOW. data == float
66                 MSG_LAST
67         };
68
69         /// Devuelve el nombre de la instancia
70         std::string get_name() const { return name; }
71         
72         /// Retorna el flujo actual que maneja el objeto.
73         float get_actual_flow() { return actual_flow; }
74         virtual void get_state_as_xml(std::stringstream &out); 
75 protected:
76         RGB fluid_color;
77         // es de solo lectura
78         std::string name;
79         bool updated;
80         float actual_flow;
81 private:
82         // Hago que no se puedan copiar objetos ElementosPlanta
83         PlantItem(const PlantItem &):IConector(0,0) {}
84         PlantItem &operator = (const PlantItem &) { return (*this); }
85 };
86
87 }
88 }
89
90 #endif
91