add event sequence diagram

UML/event.puml

@@ -0,0 +1,55 @@
+@startuml
+
+participant Behavior as b
+participant Dispatcher as d
+entity Event as e
+participant EventQueue as eq
+queue "EventQueue::queue_" as q
+
+== Create an Event ==
+|||
+?->> b ++ : GEN
+b -> e ** : new
+b -> b --++ : pushEvent
+e -> b : getBehavior
+b --> e ++: setBehavior
+e --> b --
+b -> d ++ : getDispatcher
+d --> b
+b -> d -- : pushEvent
+d ->? -- : push
+
+
+|||
+|||
+== Push Event  ==
+|||
+?->> d ++: pushEvent
+d -> eq--++: push
+eq -> q ++
+q --> eq
+eq -> q -- : pushEndQueue
+
+|||
+|||
+== Dispatch ==
+|||
+?->> d ++: executeOnce
+d -> q : getFront
+q -> e ++
+e --> q
+q --> d : event
+d -> q : pop
+deactivate q
+d -> d --++ : dispatchEvent
+d -> b ++ : getBehavior
+b --> d
+d -> b -- : process
+b -> b--: processEvent
+
+destroy e
+
+
+
+
+@enduml

UML/timeAlgorithme.puml

@@ -0,0 +1,27 @@
+@startuml
+
+start
+:newTime = 0
+totalTime = 0
+isEnd = it == list.end()
+lastTime = 0;
+
+#tomato:if (!isEnd) then (not end)
+    #tomato:totalTime += it.getRelTicks();
+endif
+
+    while ( !isEnd && (totalTime <= newTime) ) is (goForward)
+    :isEnd = (++it == list.end());
+        :lastTime = totalTime;
+        #tomato:if (!isEnd) then (not end)
+            #tomato:totalTime += it.getRelTicks();
+        endif
+    endwhile
+
+#tomato:if (!isEnd) then (not end)
+    #tomato:subRelTicks(newTime- lastTime);
+endif
+:it.setRelTicks(newTime - lastTime);
+:insert(it, newTimeout);
+
+@enduml

UML/timeout.puml

@@ -0,0 +1,62 @@
+@startuml
+
+participant "Behavior::StateMachine" as sm
+participant Dispatcher as d
+participant TimeoutManager as tm
+entity "Event::Timeout" as t
+queue "TimeoutManager::timeouts_" as timeouts
+
+autoactivate off
+|||
+|||
+== Schedule timeout ==
+|||
+sm -> sm++ : scheduleTimeout
+sm -> d ++: getDispatcher
+d --> sm --: dispatcher
+sm -> d --++ : scheduleTimeout
+d -> tm ++: getTimeoutManager
+tm --> d --: timeoutManager
+d -> tm --++ : scheduleTimeout
+tm -> t ** : new
+t --> tm
+tm -> timeouts --++: insert
+
+|||
+|||
+== Decrement timeout (and dispatch) ==
+|||
+loop every tickInterval
+?->> tm ++: tick
+tm -> timeouts : getFront
+timeouts -> t ++
+t --> timeouts
+timeouts --> tm : timeout
+tm -> t  --: decrement
+end
+|||
+note left t
+When timeout is 0,
+dispatch event
+end note
+t -> timeouts : pop
+deactivate timeouts
+t ->? --: pushEvent
+
+|||
+|||
+== Unschedule timeout ==
+|||
+sm -> sm++ : unscheduleTimeout
+sm -> d ++: getDispatcher
+d --> sm --: dispatcher
+sm -> d --++ : unscheduleTimeout
+d -> tm ++: getTimeoutManager
+tm --> d --: timeoutManager
+d -> tm --++ : unscheduleTimeout
+tm -> timeouts --: erase
+timeouts -> t !!
+
+
+
+@enduml

readme.md

@@ -8,36 +8,17 @@
 
 # Time Algorithm
 
-```plantuml
-@startuml
 
-start
+<img src="./UML/timeAlgorithme.png">
-:newTime = 0
-totalTime = 0
-isEnd = it == list.end()
-lastTime = 0;
 
-#tomato:if (!isEnd) then (not end)
+# Sequence Diagrams
- #tomato:totalTime += it.getRelTicks();
+## Timeout
-endif
 
-    while ( !isEnd && (totalTime <= newTime) ) is (goForward)
+<img src="./UML/timeout.png">
-    :isEnd = (++it == list.end());
-        :lastTime = totalTime;
-        #tomato:if (!isEnd) then (not end)
-            #tomato:totalTime += it.getRelTicks();
-        endif
-    endwhile
 
-#tomato:if (!isEnd) then (not end)
+## Event
-    #tomato:subRelTicks(newTime- lastTime);
-endif
-:it.setRelTicks(newTime - lastTime);
-:insert(it, newTimeout);
-
-@enduml
-```
 
+<img src="./UML/event.png">
 
 # Tests
 ## Test 1
@@ -50,7 +31,7 @@ The Test Factory (TestFactory01) instantiates 2 objects:
 <details>
   <summary>QT result ✅</summary>
 
-![result.PNG](./test-bench%2Ftest1%2Fide-qtcreator-test1-idf%2Fresult.PNG)
+<img src="./test-bench/test1/ide-qtcreator-test1-idf/result.PNG">
 
 This test is successfully passed
 
@@ -58,7 +39,7 @@ This test is successfully passed
 <details>
   <summary>STM result ✅</summary>
 
-![result.png](./test-bench%2Ftest1%2Fide-cubeide-test1-idf%2Fresult.png)
+<img src="./test-bench/test1/ide-cubeide-test1-idf/result.png">
 
 </details>
 
@@ -70,7 +51,7 @@ Weather or not the state machine should be deleted is handled with the 'deleteOn
 <details>
   <summary>QT result ✅</summary>
 
-![result.PNG](test-bench%2Ftest2%2Fide-qtcreator-test2-idf%2Fresult.PNG)
+<img src="./test-bench/test2/ide-qtcreator-test2-idf/result.PNG">
 
 This test is successfully passed
 
@@ -78,7 +59,7 @@ This test is successfully passed
 <details>
   <summary>STM result ✅</summary>
 
-![result.png](test-bench%2Ftest2%2Fide-cubeide-test2-idf%2Fresult.png)
+<img src="./test-bench/test2/ide-cubeide-test2-idf/result.png">
 
 </details>
 
@@ -88,7 +69,7 @@ This test checks basic event handling in state machines. In this example the Sta
 <details>
   <summary>QT result ✅</summary>
 
-![result.PNG](test-bench%2Ftest3%2Fide-qtcreator-test3-idf%2Fresult.PNG)
+<img src="./test-bench/test3/ide-qtcreator-test3-idf/result.PNG">
 
 This test is successfully passed
 
@@ -96,7 +77,7 @@ This test is successfully passed
 <details>
   <summary>STM result ✅</summary>
 
-![result.png](test-bench%2Ftest3%2Fide-cubeide-test3-idf%2Fresult.png)
+<img src="./test-bench/test3/ide-cubeide-test3-idf/result.png">
 
 </details>
 
@@ -106,7 +87,7 @@ Tests if timeouts are correctly cancelled. When leaving a state with a transitio
 <details>
   <summary>QT result ✅</summary>
 
-![result.PNG](test-bench%2Ftest4%2Fide-qtcreator-test4-idf%2Fresult.PNG)
+<img src="./test-bench/test4/ide-qtcreator-test4-idf/result.PNG">
 
 This test is successfully passed
 
@@ -114,7 +95,7 @@ This test is successfully passed
 <details>
   <summary>STM result ✅</summary>
 
-![result.png](test-bench%2Ftest4%2Fide-cubeide-test4-idf%2Fresult.png)
+<img src="./test-bench/test4/ide-cubeide-test4-idf/result.png">
 
 </details>
 
@@ -124,7 +105,7 @@ With this test multiple timeouts are added to the XFTimeoutManager list at the s
 <details>
   <summary>QT result ✅</summary>
 
-![result.PNG](test-bench%2Ftest5%2Fide-qtcreator-test5-idf%2Fresult.PNG)
+<img src="./test-bench/test5/ide-qtcreator-test5-idf/result.PNG">
 
 This test is successfully passed
 
@@ -132,7 +113,7 @@ This test is successfully passed
 <details>
   <summary>STM result ✅</summary>
 
-![result.png](test-bench%2Ftest5%2Fide-cubeide-test5-idf%2Fresult.png)
+<img src="./test-bench/test5/ide-cubeide-test5-idf/result.png">
 
 </details>
 

src/simplified/xf/core/behavior.cpp

@@ -16,6 +16,12 @@ void XFBehavior::startBehavior() {
     GEN(XFInitialEvent());
 }
 
+/**
+ * @brief Pushes the given event to the dispatcher.
+ *
+ * If the event has no behavior assigned, the behavior of this object is assigned.
+ * @param pEvent Event to push to the dispatcher.
+ */
 void XFBehavior::pushEvent(XFEvent *pEvent) {
     if(pEvent->getBehavior()==nullptr) {
         pEvent->setBehavior(this);
@@ -39,6 +45,13 @@ interface::XFDispatcher *XFBehavior::getDispatcher() {
     return interface::XFDispatcher::getInstance();
 }
 
+/**
+ * @brief Returns a reference to the actually processed timeout.
+ *
+ * Will work only if the current event is of type IXFEvent::Timeout.
+ *
+ * @return Pointer to the currently processed timeout or nullptr if the current event is not a timeout.
+ */
 const XFTimeout *XFBehavior::getCurrentTimeout() {
     if(pCurrentEvent_->getEventType() == XFEvent::Timeout) {
         return (XFTimeout*) this->pCurrentEvent_;
@@ -51,13 +64,33 @@ void XFBehavior::setCurrentEvent(const XFEvent *pEvent) {
     this->pCurrentEvent_ = pEvent;
 }
 
+/**
+ * @brief Processes the given event.
+ *
+ * The dispatcher calls this method every time a new event
+ * or timeout arrives. The process method stores the actual
+ * event using the #_pCurrentEvent and then calls
+ * processEvent().
+ *
+ * In case you intend to call process() inside your state machine you
+ * are doing something wrong! Call GEN() or pushEvent() instead!
+ *
+ * @param pEvent Event to process
+ * @return if the behavior is terminated (basically a boolean)
+ */
 XFBehavior::TerminateBehavior XFBehavior::process(const XFEvent *pEvent) {
     this->setCurrentEvent(pEvent);
+
+    // Get status of the event processing
     XFEventStatus status = XFEventStatus::Unknown;
     status = this->processEvent();
+
+    // Check if event was consumed and if it should be deleted
     if(status == XFEventStatus::Consumed && pEvent->deleteAfterConsume()) {
         delete pEvent;
     }
+
+    // Check if the behavior is terminated and return the result
     XFBehavior::TerminateBehavior terminateBehavior = false;
     if(status == XFEventStatus::Terminate) {
         terminateBehavior = true;