Merge pull request #181 from FlightControl-Master/Moose-Release

FSM Documentation
This commit is contained in:
Sven Van de Velde 2016-12-23 06:51:48 +01:00 committed by GitHub
commit 80ed9fe3f8
12 changed files with 7 additions and 8 deletions

View File

@ -15,27 +15,27 @@
-- * A **State** defines a moment in the process.
-- * An **Event** describes an action, that can be triggered both internally as externally in the FSM. An Event can be triggered Embedded or Delayed over time.
--
-- ![Test Image](../Presentations/MOOSE - FSM - 1. Concepts/Dia3.jpg)
-- ![Test Image](.\Presentations\DOC.MOOSE - FSM - 1. Concepts\Dia1.jpg)
--
-- An FSM transitions in **4 moments** when an Event is being handled.
-- Each moment can be catched by handling methods defined by the mission designer,
-- that will be called by the FSM while executing the transition.
-- These methods define the flow of the FSM process; because in those methods the FSM Internal Events will be fired.
--
-- * To catch State moments, create methods starting with OnLeave or OnEnter concatenated with the State name.
-- * To catch Event moments, create methods starting with OnBefore or OnAfter concatenated with the Event name.
-- * To handle **State** moments, create methods starting with OnLeave or OnEnter concatenated with the State name.
-- * To handle **Event** moments, create methods starting with OnBefore or OnAfter concatenated with the Event name.
--
-- ** The OnLeave and OnBefore transition methods may return false to cancel the transition.**
--
-- ![Test Image](../Presentations/MOOSE - FSM - 1. Concepts/Dia4.jpg)
-- ![Test Image](.\Presentations\DOC.MOOSE - FSM - 1. Concepts\Dia3.jpg)
--
-- The FSM creates for each Event **two Event trigger methods**.
-- There are two modes how Events can be triggered, which is **embedded** and **delayed**:
--
-- * The **FSM:Event()** creates an Event that will be processed **embedded** or immediately.
-- * The **FSM:__Event( seconds )** creates an Event that will be processed **delayed** over time, waiting x seconds.
-- * The method **FSM:Event()** triggers an Event that will be processed **embedded** or **immediately**.
-- * The method **FSM:__Event( seconds )** triggers an Event that will be processed **delayed** over time, waiting x seconds.
--
-- ![Test Image](../Presentations/MOOSE - FSM - 1. Concepts/Dia5.jpg)
-- ![Test Image](.\Presentations\DOC.MOOSE - FSM - 1. Concepts\Dia4.jpg)
--
-- 1.1) Define the FSM Rules
-- -------------------------

@ -1 +0,0 @@
Subproject commit 30f1ab19a933a9e861e037f106070c23725a0c9f

View File

Before

Width:  |  Height:  |  Size: 182 KiB

After

Width:  |  Height:  |  Size: 182 KiB

View File

Before

Width:  |  Height:  |  Size: 220 KiB

After

Width:  |  Height:  |  Size: 220 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 232 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 225 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 174 KiB