Agrego un pedorro manual de usuario :-)

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

diff --git a/Model/include/iconector.h b/Model/include/iconector.h
index 3ca3f2b394e9bbb5e4ce1e481203940dc609af4d..2abcbfe0f4bb5977c5da9ac0ac66a72657916091 100644 (file)
--- a/Model/include/iconector.h
+++ b/Model/include/iconector.h
@@ -7,27 +7,51 @@
 
 namespace PlaQui {
 
 
 namespace PlaQui {
 

+namespace Model {

 /** Conector genérico de elementos
 /** 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:
  */
 class IConector {
 public:

-       /// Constructor
+       /** Constructor
+        *
+        *  \param in Cantidad de entradas
+        *  \param out Cantidad de salidas
+        */

        IConector(unsigned in, unsigned out);
        /// Destructor
        virtual ~IConector();
 
        /** Envía un mensage a los elementos conectados
         *
        IConector(unsigned in, unsigned out);
        /// Destructor
        virtual ~IConector();
 
        /** Envía un mensage a los elementos conectados
         *

-        *  Esvía un mensage a los elementos conectados a la entrada o
+        *  Envía un mensage a los elementos conectados a la entrada o

         *  a la salida.
         *  \param where Donde enviar el mensage, IConector::IN o IConector::OUT
         *  \param msg Mensage a enviar
         *  a la salida.
         *  \param where Donde enviar el mensage, IConector::IN o IConector::OUT
         *  \param msg Mensage a enviar

-        *  \return Respuesta al mensage. Se interpreta dependiendo del mensage
+        *  \param data dato opcional a mandar, según el mensage que se envíe

         */
         */

-       int send_msg(int where, int msg);
+       void send_msg(int where, int msg, void *data=NULL);

        
        

-       /// Recive un mensage
-       virtual void recieve_msg(int msg, IConector *who);
+       /** Recibe un mensage
+        *
+        *  Este procedimiento atiende los mensages enviados por otros objetos.
+        *  El mensage \e msg es enviado por \e who, quien puede enviar opcionalmente
+        *  un dato en \e data. El campo \e data debe ser interpretado en forma
+        *  correcta dependiendo del mensage enviado.
+        *  El objeto que recibe un mensage puede, de ser necesario, responder al
+        *  objeto que lo envió llamando directamente al método recieve_msg del objeto
+        *  \e who. No se recomienda enviar un mensage mediante send_msg ya que puede
+        *  ocacionar que objetos que no esten esperando una respuesta se comporte de
+        *  manera indeterminada.
+        *  \param msg ID del mensage enviado.
+        *  \param who Objeto que envía el mensage.
+        *  \param data Dato opcional a enviar.
+        */
+       virtual void recieve_msg(int msg, IConector *who, void *data);

 
        /** Conecta un objeto con otro
         *
 
        /** Conecta un objeto con otro
         *


@@ -39,7 +63,7 @@ public:
 
        /// Constantes de posición donde conectar
        enum {
 
        /// Constantes de posición donde conectar
        enum {

-               IN, ///< conectar a la entrada
+               IN=0, ///< conectar a la entrada

                OUT ///< conectar a la salida
        };
 
                OUT ///< conectar a la salida
        };
 


@@ -79,6 +103,8 @@ private:
        IConector &operator = (const IConector &) { return (*this); }
 };
 
        IConector &operator = (const IConector &) { return (*this); }
 };
 

-}
+} // namespace Model
+} // namespace PlaQui

 
 #endif // _I_CONECTOR_H_
 
 #endif // _I_CONECTOR_H_

+