testing/037_msc.cpp

   1 // objective: test the \msc and \endmsc commands
   2 // check: class_sender.xml
   3 // check: class_receiver.xml
   4 // check: 037__msc_8cpp.xml
   5
   6 /** \file
   7  * A bit more complex msc diagram, with also parallel events.
   8  * \msc
   9  * Sender_1,Receiver_1,Sender1_1,
  10  * Sender,Receiver,Sender1,
  11  * Sender_2,Receiver_2,Sender1_2;
  12  *
  13  * Sender_1->Receiver_1 [label="Command()", URL="nref Receiver::Command()"],
  14  * Sender1_1<-Receiver_1 [label="Ack()", URL="nref Ack()", ID="1"];
  15  *
  16  * Sender->Receiver [label="Command()", URL="nref Receiver::Command()"];
  17  * Sender1<-Receiver [label="Ack()", URL="nref Ack()", ID="1"];
  18  * Sender_2->Receiver_2 [label="Command()", URL="nref Receiver::Command()"],
  19  * Sender1_2<-Receiver_2 [label="Ack()", URL="nref Ack()", ID="1"];
  20  * \endmsc
  21  */
  22
  23 /** Sender class. Can be used to send a command to the server.
  24  *  The receiver will acknowledge the command by calling Ack().
  25  *  \msc
  26  *    Sender,Receiver;
  27  *    Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"];
  28  *    Sender<-Receiver [label="Ack()", URL="\ref Ack()", ID="1"];
  29  *  \endmsc
  30  */
  31 class Sender
  32 {
  33   public:
  34     /** Acknowledgement from server */
  35     void Ack(bool ok);
  36 };
  37
  38 /** Receiver class. Can be used to receive and execute commands.
  39  *  After execution of a command, the receiver will send an acknowledgement
  40  *  \msc
  41  *    Receiver,Sender;
  42  *    Receiver<-Sender [label="Command()", URL="\ref Command()"];
  43  *    Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
  44  *  \endmsc
  45  */
  46 class Receiver
  47 {
  48   public:
  49     /** Executable a command on the server */
  50     void Command(int commandId);
  51 };