When Rational Statemate uses this function to sort a specified list of elements by branches and it encounters two or more charts at the same level of hierarchy, it sorts them alphabetically by name.
Note: This function is relevant only for a list of hierarchical elements. If the function is applied to a list of non-hierarchical elements,status
receives the valuestm_elements_not_hierarchical
.
Input/Output The list of Rational Statemate elements. Hierarchical elements in a chart can be ordered by branches. Consider the following statechart:The set of elements, {S,S1,S11
}, comprise a branch. Assume you perform asort_by_branch
function on statechart S. The sorted order would be:S
,S1
,S11
,S2
.The order in which branches appear in the output is arbitrary. However, the order of states appearing within each branch are ordered from top-to-bottom (S
toS11
, for example).