* Se comenta un poco más el modelo.

diff --git a/Model/include/drain.h b/Model/include/drain.h
index 25f75d850d20c76d169630f4f043fa4a4be5d762..df27e8fe69de32c6847bfe6beb75adff0264d9fd 100644 (file)
--- a/Model/include/drain.h
+++ b/Model/include/drain.h
@@ -35,5 +35,6 @@ private:
 
 }
 }
+
 #endif // _H_SOURCE_H_
 

diff --git a/Model/include/iconector.h b/Model/include/iconector.h
index 916d34175a0549d2ea8cf281508502669e88045a..f3f67601cfd8a30ba5b923d132053bca99fea0d5 100644 (file)
--- a/Model/include/iconector.h
+++ b/Model/include/iconector.h
@@ -9,6 +9,11 @@ namespace PlaQui {
 
 namespace Model {
 /** Conector genérico de elementos
+ *
+ *  El conector es un interfaz común que permite a objetos de distinto
+ *  tipo comunicarse entre sí sin la necesidad de conocerse.
+ *  Maneja una lista de elementos conectados a uno, que pueden estar
+ *  tanto conectados a una entrada como a una salida.
  */
 class IConector {
 public:

diff --git a/Model/include/splitter.h b/Model/include/splitter.h
index 7adbb49fd6171f8585f81fa18e60dffeb0552a92..a76c1179bb8e352eed39548340146c30ac2da20d 100644 (file)
--- a/Model/include/splitter.h
+++ b/Model/include/splitter.h
@@ -8,9 +8,15 @@ namespace PlaQui {
 
 namespace Model {
 
+/** Divisor de Flujo
+ *
+ *  Divide el flujo entrante en 2 partes iguales que envía a sus salidas
+ */
 class Splitter:public Transport {
 public:
+       /// Constructor
        Splitter(const std::string &_name);
+       /// Destructor
        virtual ~Splitter();
 
        virtual void recieve_msg(int msg, IConector *who, void *data);

diff --git a/Model/include/tank.h b/Model/include/tank.h
index d4173af74cbc10aa5ed8b8ea9b5a0e1123618c18..dbb56c41267670f179a01981d6a4bd95f4e6ff60 100644 (file)
--- a/Model/include/tank.h
+++ b/Model/include/tank.h
@@ -9,10 +9,20 @@
 namespace PlaQui {
        
 namespace Model {
-                               
+
+/** Tanque de Agua/Líquido
+ *
+ *  Se modela un tanque con una entrada y una salida. La cantidad máxima
+ *  de flujo entrante estará dada por la diferencia entre la capacidad
+ *  y la cantidad actual de líquido en el tanque.
+ *  La cantidad máxima de flujo que puede ofrecer a la salida está dada
+ *  por la cantidad de líquido en el tanque.
+ */ 
 class Tank:public Source, public Drain {
 public:
+       /// Constructor
        Tank(const std::string &_name);
+       /// Destructor
        virtual ~Tank();
 
        virtual bool get_output();
@@ -21,9 +31,9 @@ public:
        virtual void update();
        virtual void simulate();
 protected:
-       float litros;   
-       float actual_in_flow;
-       float actual_out_flow;
+       float litros;   ///< cantidad de líquido actual
+       float actual_in_flow; ///< flujo máximo a la entrada
+       float actual_out_flow; ///< flujo máximo de la salida
 private:
        Tank():Drain("null"),Source("null"),Control("null") {}
        Tank &operator = (const Tank &) { return *this; } 
@@ -33,3 +43,4 @@ private:
 }
 
 #endif // _TANK_H_
+

diff --git a/Model/include/union.h b/Model/include/union.h
index b08bc2368e4d57255dca3776f2c7edc904ee5dd7..0f494a207d7d776d4966f34e3044bde5edeb4fef 100644 (file)
--- a/Model/include/union.h
+++ b/Model/include/union.h
@@ -8,16 +8,25 @@ namespace PlaQui {
 
 namespace Model {
 
+/** Convina 2 flujos entrantes
+ *
+ *  Este objeto tiene 2 entradas y una salida. El flujo entrante por cada salida
+ *  se convina y se manda por la salida, aplicando la correcta suma de los colores.
+ *
+ *  TODO : Hacer que anda bien
+ */
 class Union:public Transport {
 public:
+       /// Constructor
        Union(const std::string &_name);
+       /// Destructor
        virtual ~Union();
 
        virtual void recieve_msg(int msg, IConector *who, void *data);
        virtual void update(int dir=OUT);
        virtual void simulate();
 protected:
-       int in_on_zero;
+       int in_on_zero; 
        int in_ready;
 private:
        Union(const Union &):Transport("null") {}