Author: derek Date: Mon Nov 13 17:58:24 2006 New Revision: 191 Added: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Add this to version control Added: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Mon Nov 13 17:58:24 2006 @@ -0,0 +1,52 @@ +/*! \page pageEachIcon Description of each icon within CallFlow + +\section secEachIntro Introduction + +There are numerous control structures that the user may place on the drawing +area. We describe each of them in this page of the manual. Also described is +how one would use each structure within a call flow diagram. + +\subsection subsecStartFlow Initiate graph processing + +The toolbar icon \image html Controlsstart.png +is used to indicate that the user wishes to place the "Initiate graph +processing" item on the screen, which looks like: +\image html startflow.png "Initiate graph processing" + +It is mandatory that there is only one of these items on each graph. Placing +more than 1 item is ambiguous - where would call processing start ? + + + +\subsection subsecJoinObjects Join objects on the drawing area + +The toolbar icon, \image html JoinObjects.png +indicates a user drawn multiline segment object that connects objects. +Select the toolbar icon, move to the drawing area, and left click to mark the +points on the shape and complete with the right mouse button. +Once completed, you may move the shape by selecting it with the left button +or shift left to select multiple objects. + +When there is a valid connection at both ends of this object, a filled black +circle is drawn at each end. + +It is entirely valid to have the output of several items connected to one +item. Thus, the following shape is valid, + +\image html validjoinexample.png "Valid use of the join objects structure" + +and this shape is invalid. +\image html faultyjoinexample.png "Incorrect use - the graph is ambiguous" + +The invalid shape is ambiguous - it is not clear where the flow of execution +should go. In this example, I suppose, it would "work", in that there is no +difference if either path is followed. + + + + + + + + +*/ \ No newline at end of file