overview.textile 4.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. p(edit-on-github). "Edit on GitHub":https://github.com/Yakindu/statecharts/edit/master/plugins/org.yakindu.sct.doc.user/src/user-guide/overview.textile
  2. h1(#what-are-yakindu-statechart-tools). What are YAKINDU Statechart Tools?
  3. The statechart tools are a central part of YAKINDU: the modular toolkit for model-driven development of embedded systems. It is based on the open-source development platform Eclipse. YAKINDU Statechart Tools (YAKINDU SCT) provide the following tools to deal with state machine diagrams:
  4. * *Statechart diagram editor* to graphically create and edit statecharts
  5. * *Statechart simulator* to simulate the behavior of statecharts
  6. * *Code generators for Java, C, C++* to transform statecharts into code
  7. * *Custom generator projects* to easily create model-to-text transformations with Xtend or Java
  8. * *Integrated validator* to check for syntactical or semantical problems of the statechart model
  9. The following graph shows these features and their relation to each other:
  10. !(standard-image)images/docu_YAKINDU_features.png(Features of YAKINDU Statechart Tools)!
  11. p=. Features of YAKINDU Statechart Tools
  12. h2(#oss_which-licensing-rules-do-apply). Which licensing rules do apply to YAKINDU Statechart Tools?
  13. The source code of YAKINDU Statechart Tools is provided under the "Eclipse Public License":http://www.eclipse.org/legal/epl-v10.html.
  14. The open source code generators coming with YAKINDU Statechart Tools do not imply any license constraints on the generated code whatsoever. The generated code is property of the user (as person or organization). There is no need to make the generated code open source. The user is free to choose any license model for the generated code.
  15. h2(#who-is-behind-yakindu-statechart-tools). Who is behind YAKINDU Statechart Tools?
  16. The main part of YAKINDU Statechart Tools is an open-source project, available at "http://www.yakindu.org/":http://www.yakindu.org/. Most developers are working for itemis, a well-known consulting company specialized on model-based development.
  17. You may ask: Where does the money for open-source development come from? Well, itemis is providing professional services around YAKINDU, be it training or on-site consulting, be it development of prototypes or implementation of full-blown IDEs for programming languages, you name it. The itemis YAKINDU developers do not only know the framework very well but are also experts in programming and domain-specific language design. If you need advice get in contact with itemis' "YAKINDU team":https://info.itemis.com/contact.
  18. h2(#who-is-using-yakindu-statechart-tools). Who is using YAKINDU Statechart Tools?
  19. Initially YAKINDU Statechart Tools have been designed for the embedded systems industry: automotive, system controls, vending machines etc. However, YAKINDU Statechart Tools are bringing the benefits of Finite State Machines (FSM) and Harel Statecharts to everyone who needs to design, simulate and develop behavior. People can use YAKINDU Statechart Tools to generate Java, C, or C++ code.
  20. ###.. FIXME: Decide what to do with the following subsection regarding the document structure.
  21. ###.. FIXME: h3(#what-is-the-structure-of-this-documentation). What is the structure of this documentation?
  22. <orderedlist numeration="arabic">
  23. <listitem>
  24. <para><link linkend="yakindu-statechart-tools-user-guide">Overview</link></para>
  25. </listitem>
  26. <listitem>
  27. <para><link xl:href="../02_installation/installation.html">Installation</link></para>
  28. </listitem>
  29. <listitem>
  30. <para><link xl:href="../03_getting_started/getting_started.html">Getting Started</link></para>
  31. </listitem>
  32. <listitem>
  33. <para><link xl:href="../04_code_generation/code_generation.html">Code generation</link></para>
  34. </listitem>
  35. <listitem>
  36. <para><link xl:href="../05_reference/reference.html">Reference</link></para>
  37. </listitem>
  38. <listitem>
  39. <para><link xl:href="../06_tasks/tasks.html">Task</link></para>
  40. </listitem>
  41. </orderedlist>
  42. -->
  43. </sect3>