X-Git-Url: https://git.llucax.com/z.facultad/75.42/plaqui.git/blobdiff_plain/acf9258bf769e7a5c87adb453945943770a2d6b8..d940cfcd9606fbf7fc82376260f3a63573fd3795:/Model/include/iconector.h?ds=sidebyside diff --git a/Model/include/iconector.h b/Model/include/iconector.h index 3ca3f2b..916d341 100644 --- a/Model/include/iconector.h +++ b/Model/include/iconector.h @@ -7,27 +7,45 @@ namespace PlaQui { +namespace Model { /** Conector genérico de elementos */ 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 * - * 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 - * \return Respuesta al mensage. Se interpreta dependiendo del mensage */ - 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 * @@ -79,6 +97,8 @@ private: IConector &operator = (const IConector &) { return (*this); } }; -} +} // namespace Model +} // namespace PlaQui #endif // _I_CONECTOR_H_ +