Index: sources/canbus/messagedispatcher.h =================================================================== diff -u -rc5389647e2259e67f8e6d923f3481d7d3f4eab68 -rb5c381df9625b215d27649976825c64a4c4ca4f0 --- sources/canbus/messagedispatcher.h (.../messagedispatcher.h) (revision c5389647e2259e67f8e6d923f3481d7d3f4eab68) +++ sources/canbus/messagedispatcher.h (.../messagedispatcher.h) (revision b5c381df9625b215d27649976825c64a4c4ca4f0) @@ -28,52 +28,52 @@ using namespace Gui; namespace Can { /*! - * \brief The MessageDispatcher class - * \details Message Dispatcher is the class which is the mediator between CanBus Frames - * and Application Messages. - * The massages and frames need to be interpreted form/to hex - * and also need to be split into frames or constructor from frames to be a message. - * ---------------------------------------------------------------------------------------- - * - * Interpreter : message [ toHex , fromHex] - * - * Builder : message [ toFrame , fromFrame ] - * - * Dispatcher : signal->Handler( .. frame .. ) - * - * Handler : signal->Dispatcher( .. frame .. ) - * - * ---------------------------------------------------------------------------------------- - * - * *** UI <-> AppController <-> Dispatcher <-> Handler <-> HD *** - * - * ---------------------------------------------------------------------------------------- - * - * UI -> message -> - * AppController { - * signal->Dispatcher ( .. message .. ) - * } - * - * Dispatcher { - * .. - * messageList[ch][frameList] += Builder.toFrame ( Interpreter.toHex ( message ) ) - * .. - * signal->Handler( .. frame .. ) - * } - * - * ---------------------------------------------------------------------------------------- - * - * HD -> frame -> - * Handler { - * signal->Dispatcher ( .. frame .. ) - * } - * - * Dispatcher { - * messageList[ch][frameList] += Interpreter.fromHex( frame ) - * isComplete => Builder.fromFrame( frameList ) : signal->AppController - * } - * - * ---------------------------------------------------------------------------------------- + * \brief The MessageDispatcher class \n + * \details Message Dispatcher is the class which is the mediator between CanBus Frames \n + * and Application Messages. \n + * The massages and frames need to be interpreted form/to hex \n + * and also need to be split into frames or constructor from frames to be a message. \n + * ---------------------------------------------------------------------------------------- \n + * \n + * Interpreter : message [ toHex , fromHex] \n + * \n + * Builder : message [ toFrame , fromFrame ] \n + * \n + * Dispatcher : signal->Handler( .. frame .. ) \n + * \n + * Handler : signal->Dispatcher( .. frame .. ) \n + * \n + * ---------------------------------------------------------------------------------------- \n + * \n + * *** UI <-> AppController <-> Dispatcher <-> Handler <-> HD *** \n + * \n + * ---------------------------------------------------------------------------------------- \n + * \n + * UI -> message -> \n + * AppController { \n + * signal->Dispatcher ( .. message .. ) \n + * } \n + * \n + * Dispatcher { \n + * .. \n + * messageList[ch][frameList] += Builder.toFrame ( Interpreter.toHex ( message ) ) \n + * .. \n + * signal->Handler( .. frame .. ) \n + * } \n + * \n + * ---------------------------------------------------------------------------------------- \n + * \n + * HD -> frame -> \n + * Handler { \n + * signal->Dispatcher ( .. frame .. ) \n + * } \n + * \n + * Dispatcher { \n + * messageList[ch][frameList] += Interpreter.fromHex( frame ) \n + * isComplete => Builder.fromFrame( frameList ) : signal->AppController \n + * } \n + * \n + * ---------------------------------------------------------------------------------------- \n */ class MessageDispatcher : public QObject { @@ -97,8 +97,22 @@ void actionTransmit(GuiActionType vActionId, const QVariantList &vData); signals: - // When frames received and processed to action and are ready then notifies UI Action is ready + /*! + * \brief didActionReceive + * \details When a message received over the CANBUS this signal is emitted + * on successful collecting all required payloads from different frames if any + * and successfully has been built into a message and can be interpreted + * \param vAction - The action has been extracted from CANBUS message header to be done + * \param vData - The data has been collected from CANBUS frame(s) + */ void didActionReceive(GuiActionType vAction , const QVariantList &vData); + /*! + * \brief didFrameTransmit + * \details When a message is requested to be transmitted this signal is emitted + * on successful interpretation and building the message into frames + * \param vCanId - Target channel of the CANBUS message + * \param vPayload - The payload of the message to be sent + */ void didFrameTransmit(Can_Id vCanId , const QByteArray &vPayload); private slots: