- Se agrega el metodo Model::Simulator::set_open() para abrir y cerrar bombas y

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

diff --git a/Model/include/bypass.h b/Model/include/bypass.h
index 4282752e4f8593b6956ae8bd0236e0b45a04017b..689a049f724e81c36b89fcd1799f93529a430f22 100644 (file)
--- a/Model/include/bypass.h
+++ b/Model/include/bypass.h
@@ -10,6 +10,21 @@
 namespace PlaQui {
 namespace Model {
 
+/** Paso directo de dato
+ *
+ *  Este elemento tiene la funcionalidad para trabajar como entrada
+ *  o salida de un elemento conectado.
+ *  Si el elemento es utilizado como entrada, a este se le conecta
+ *  lógica de control a su entrada. Cuando el elemento al que sirve
+ *  requiere saber su estado, llama al método get_output de este objeto
+ *  y este le responde segun corresponda.
+ *  Si este objeto es utilizado como salida, se le debe asignar un
+ *  elemento a quién controlar. Cuando la lógica de control llama
+ *  al get_output de éste objeto, éste le consulta al objeto a quién
+ *  controla para pasar el dato al circuito lógico.
+ *  \see Pump
+ *  \see Exclusa
+ */
 class ByPass:public LogicControl {
 public:
        ByPass():LogicControl(1,1) { control = NULL; }
@@ -18,12 +33,11 @@ public:
        virtual bool get_output() {
                LogicControl *mi_entrada;
                bool mi_salida = false;
-               // Si tengo conectado algo a mi salida, es porque
+               // Si tengo asignado un objeto a quien controlar, es porque
                // le tengo que consultar a el.
-               // Si no tengo nadia a mi salida, es porque tengo 
-               // que consultar a mis entradas
+               // Si no, es porque tengo que consultar a mis entradas
                if (control == NULL) {
-                       // No tengo nadie a mi salida!, pregunto a mis entradas, si es
+                       // No tcontrolo a nadie!, pregunto a mi entradas, si es
                        // que tengo!!
                        if (in_list.begin() != in_list.end()) {
                                mi_entrada = (LogicControl *)(*in_list.begin());
@@ -57,5 +71,5 @@ protected:
 }
 }
 
-#endif // _OR_H_
+#endif // _BYPASS_H_