- saco estos archivos porque no los uso y me molestan

[z.facultad/75.42/plaqui.git] / Model / include / bomb.h

diff --git a/Model/include/bomb.h b/Model/include/bomb.h
index 468bbb56b955f26dfb6d2731d94fe99df47de70d..ebba1275bc72cb3fbf473114cd51db697edc8aa9 100644 (file)
--- a/Model/include/bomb.h
+++ b/Model/include/bomb.h
@@ -8,10 +8,27 @@ namespace PlaQui {
 
 namespace Model {
 
+/** Bomba hidráulica
+ *
+ *  La bomba es un elemento que toma líquido de alguna fuente
+ *  misteriosa y lo envía por su salida. La cantidad de fluido que
+ *  envía va a depender exclusivamente del sistema al cual está conectado.
+ *  La bomba es "inteligente", y es capaz de reducir el flujo que envía
+ *  dependiendo de las condiciones que le ponga el sistema, reduciendo
+ *  así el flujo de manera automática para evitar sobrecargas.
+ *
+ *  La bomba tiene 2 interruptores, uno manual y otro automático.
+ *  Si el manual está apagado, la bomba se considera apagada e ignora
+ *  todo mensage del interruptor automático. En esta condición envía
+ *  0 cuando se le consulta por su flojo máximo.
+ *
+ */
 class Bomb:public Source {
 public:
+       /// Constructor
        Bomb(const std::string &_name);
-       ~Bomb();
+       /// Destructor
+       virtual ~Bomb();
 
        virtual void update();
        virtual void simulate();
@@ -20,7 +37,9 @@ public:
 
        virtual void recieve_msg(int msg, IConector *who, void *data);
 
+       /// Activa la bomba
        void activate() { active = true; }
+       /// Desactiva la bomba
        void deactivate() { active = false; }
 protected:
        /** Define si la bomba esta abierta o no. Esto lo maneja la logica de