Author: derek Date: Wed Nov 15 23:20:36 2006 New Revision: 205 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Add description for more icons in the tool bar. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Wed Nov 15 23:20:36 2006 @@ -9,6 +9,7 @@ The control structures described in this page are \li \ref subsecConditional \li \ref subsecEndCall +\li \ref subsecEndFor \li \ref subsecEndEverything \li \ref subsecEndProcessing \li \ref subsecEventer @@ -17,6 +18,7 @@ \li \ref subsecReadFromFile \li \ref subsecRequestNode \li \ref subsecStartFlow +\li \ref subsecStartFor \li \ref subsecTimer \li \ref subsecTransferMedia \li \ref subsecWriteToFile @@ -91,6 +93,36 @@ +\subsection subsecEndFor End For Loop + +The end for loop item is indicated by the toolbar icon and drawing area +image of + +<CENTER><TABLE frame=void border=0><TR><TD> +\image html Controlsend_for.png +</TD><TD> + +</TD><TD> +\image html endfor.png +</TD></TR> +</TABLE></CENTER> + + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. There are no other options relevant to this +icon. All initialisation and loop increments are handled in the \ref +subsecStartFor item. + +Remember that if you set up a busy wait loop where execution cannot move into +an \ref subsecEndProcessing item, there will be no sending of messages, and no +event handling. + + + + + + + \subsection subsecEndEverything End Everything The toolbar icon and a rendering of a drawing area shape for the "End Everything" item is shown below. @@ -435,6 +467,52 @@ +\subsection subsecStartFor Start For Loop + +The start for loop item is indicated by the toolbar icon and drawing area +image of + +<CENTER><TABLE frame=void border=0><TR><TD> +\image html Controlsfor.png +</TD><TD> + +</TD><TD> +\image html startfor.png +</TD></TR> +</TABLE></CENTER> + + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The second box describes the initialisation code. Note that all elements of +this graph will have access to the variable used here. The termination test +and increment are in the second and third boxes. + +The flow of execution is identical to that in the for loop of C. The +initialisation is done, and then the test is carried out. If the test returns +True, execution moves to the item directly below the start for loop. If +the test returns False, execution moves to the connected \ref subsecEndFor and +down. + +At the end of the loop, execution moves back from the connected \ref +subsecEndFor, the increment is carried out, and then the test is +performed. Execution moves to the next item as before. + +It is entirely legal to set up a for loop where there is no initialisation +statement, the test returns True, and no increment statement. In this case, +you have a loop that will run for ever. The graph should include some path +that will take the execution away from this loop. + +Remember that if you set up a busy wait loop where execution cannot move into +an \ref subsecEndProcessing item, there will be no sending of messages, and no +event handling. + + + + + + \subsection subsecTimer Timer A timer is indicated by the toolbar icon and drawing area image of <CENTER><TABLE frame=void border=0><TR><TD> @@ -530,6 +608,11 @@ controller is managing an incoming voip call. The voip call can be connected to an answering machine, then to a conference room, then to second voip call etc. In this way, one can get the controller to replicate an IVR system. + + + + + \subsection subsecWriteToFile Write to file Write to file is an answering machine specific function, and is indicated by