Audean Wiki

User Tools

Site Tools

You are here: Audean Wiki for Mediacore services » OSInet FSM » Tools usable with the OSInet FSM
Trace:
fsm:tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
fsm:tools [2007/05/03 15:36] – fgmfsm:tools [2020/11/23 17:23] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Tools usable with the OSInet FSM ====== ====== Tools usable with the OSInet FSM ======
 +===== Generating FSM from UML State machine diagrams =====
  
-===== Generating FSM files =====+Since the FSM (>= 1.3) now uses external schema files, it seems only logical to generate these from a visual editor instead of hand-typing them. And with OOo being the de facto standard for office work, OOo Draw seems a logical choice. 
  
-Since the FSM (>= 1.3) now uses external schema files, it seems only logical to generate these from a visual editor instead of hand-typing them. And with OOo being the de facto standard for office work, OOo Draw seems a logical choice. In addition, while I'd gladly have used Dia or Inkscape as a drawing tools, both are significantly less easy to use for this type of diagramming (IMHO).+In addition, while I'd gladly have used Dia or Inkscape as a drawing tools, both are significantly less easy to use for this type of diagramming (IMHO), so the first UML to FSM converter rests on OOo Draw.
  
 +Now, how can one go about it ? Simply enough, with OpenDocument being an open standard, its layout is rather obvious. 
  
-Now, how can one go about it ? Simply enough, with OpenDocument being an open standard, its layour is rather obvious. +However, in the long run, Dia has dedicated UML formatting, and hence seems a more logical choice, although it is far less easy to use. So the maintained converter, at least for now, uses Dia files.
  
-==== The FSM subset of OOo Draw ====+==== OOo Draw to FSM ==== 
 +=== A FSM subset for OOo Draw ===
  
 The data in OpenDocument drawings is held in the ''office:document-content/office:body/office:drawing/draw:page'' element of the ''content.xml'' file in the zipped archive making up an OpenDocument document. The data in OpenDocument drawings is held in the ''office:document-content/office:body/office:drawing/draw:page'' element of the ''content.xml'' file in the zipped archive making up an OpenDocument document.
Line 18: Line 21:
     * ''draw:start-shape'' defines the ID of the transition entry state     * ''draw:start-shape'' defines the ID of the transition entry state
     * ''draw:end-shape'' defines the ID of the transition exit state     * ''draw:end-shape'' defines the ID of the transition exit state
-    * the child ''text:p' element defines UML description of the transition, the content of which we can parse as an UML description+    * the child ''text:p'' element defines UML description of the transition, the content of which we can parse as an UML description
       * name       * name
       * event guard (ignored in version 1.3)       * event guard (ignored in version 1.3)
Line 24: Line 27:
       * action       * action
  
- +=== Sample data ===
-==== Sample data ====+
  
 This following excerpt represents the useful part of a two-state transition diagram: This following excerpt represents the useful part of a two-state transition diagram:
-<file>+ 
 +<file xml>
    [..snip..]    [..snip..]
     <draw:page draw:name="page1" draw:style-name="dp1" draw:master-page-name="Standard">     <draw:page draw:name="page1" draw:style-name="dp1" draw:master-page-name="Standard">
Line 53: Line 56:
 </file> </file>
  
-===== Parsing the graph =====+=== Parsing the graph ===
  
 Supposing for now that the OOo document has already been unzipped to directory ''draw2'', here is a possible piece of code to parse the FSM: Supposing for now that the OOo document has already been unzipped to directory ''draw2'', here is a possible piece of code to parse the FSM:
-<php> 
-<?php 
  
 +<code php>
 error_reporting(E_ALL|E_STRICT); error_reporting(E_ALL|E_STRICT);
-  +
 $doc = new DOMDocument(); $doc = new DOMDocument();
 $doc->preserveWhiteSpace = false; $doc->preserveWhiteSpace = false;
 $doc->load('draw2/content.xml'); $doc->load('draw2/content.xml');
- 
 $xpath = new DOMXPath($doc); $xpath = new DOMXPath($doc);
 $xpath->registerNamespace('office', "urn:oasis:names:tc:opendocument:xmlns:office:1.0"); $xpath->registerNamespace('office', "urn:oasis:names:tc:opendocument:xmlns:office:1.0");
Line 77: Line 78:
   . ')';   . ')';
 $result = $xpath->query($qnodes, $doc); $result = $xpath->query($qnodes, $doc);
- 
 foreach ($result as $node) foreach ($result as $node)
   {   {
Line 102: Line 102:
     }     }
   }   }
-</php>+</code> 
 + 
 +From there on, it's a simple matter of merging the two trees and generating the resulting FSM XML file. 
 + 
 +==== Dia UML to FSM ==== 
 + 
 +Like OOo, Dia saves its content in an easy to parse zipped XML format. 
 + 
 +Since Dia includes dedicated UML widgets, these can be used to semantically extract them instead of relying on format limitations as was the case in the OOo converter test. 
 + 
 +The elements recognized are: 
 + 
 +  * "UML - State Term": used for initial and final states 
 +  * "UML - State": used for other states 
 +  * "UML - Transition": used for transitions. Properties include: 
 +    * Trigger (event) 
 +    * Guard (event outcome) 
 +    * Action (post-state-switch behaviour) 
 + 
 +Other UML elements are available but not processed yet. The "UML - Fork" division/reunion bar could be the next addition, but state nesting is not being considered.
fsm/tools.1178206574.txt.gz · Last modified: 2020/11/23 17:23 (external edit)