Modeling with Sequence Diagram

http://staruml.sourceforge.net/docs/user-guide%28en%29/ch05_3.html

Modeling with Sequence Diagram

The following elements are available in a sequence diagram.

• Object
• Stimulus
• SelfStimulus
• Combined Fragment
• Interaction Operand
• FrameSubsytem

Object

Procedure for creating object

In order to create object,

1. Click [Toolbox] -> [Sequence] -> [Object] button.
   
2. And click at the position where object will be placed in the [main window].
3. Object quick dialog is shown. At the quick dialog, enter the object name.
   
4. Press [Enter] key.
   

Procedure for setting active object

In order to set class to active object,

1. Set assigned class's [IsActive] property to true.
   
2. For MyObject, change MyClass's IsActive property.
   
3. If class property is not assigned, you can't change object to active object. The result is as follows.
   

Procedure for setting to multi object

In order to set object to multi object,

1. Set object's [IsMultiInstance] property to true.
   
2. Then the object is changed to multi object.
   

Procedure for creating object from class

In order to create object from class,

1. Select class in the [model explorer].
   
2. Drag and drop it into [main window].
   
3. Finally, a object is created on the diagram.
   

Procedure for creating class from object

If class is not assigned to object,

1. Double-click object to pop up quick dialog, click add class button
   
2. At the [Enter element name] dialog, enter the new class name.
   
3.  And new class is created and assigned to object.
   
4. If you want existing class to be assigned to object, click button in object's classifier property, and select class to be assigned to object at the [Select a model element] dialog.
   

Procedure for creating outgoing from object stimulus by using shortcut creation syntax

In order to create outgoing stimulus from selected object to another object,

1. Double-click from-object, or select from-object and press [Enter] key to pop up quick dialog.
2. At the quick dialog, enter stimulus name after "->" string ("<-" string for incoming and "<->" for outgoing with return).
   
3. Press [Enter] key and outgoing stimulus from selected object to target object is created and placed at the last order.
   

Stimulus

Semantics

A Stimulus is a communication between two Instances that conveys information with the expectation that action will ensue. A Stimulus will cause an Operation to be invoked, raise a Signal, or cause an Instance to be created or destroyed.

Procedure for creating stimulus

In order to create stimulus,

1. Click [Toolbox] -> [Sequence] -> [Stimulus] button.
   
2. Drag from one object, and drop to the other(object or lifeline) in the[main window] in outgoing direction.
   
3. Stimulus quick dialog is opened. Enter the stimulus name at the quick dialog and press [Enter] key.
   
4. Finally, a stimulus is created as follows.
   

Procedure for using operation in class as stimulus

If classifier property of receiver(object) of stimulus is assigned and you want to assign operation to stimulus,

1. Double-click stimulus
2. Click button at the quick dialog.
   
3. Select operation on the [Select an operation] dialog, and click [OK] button.
   
4. New stimulus mapped to class's operation is added as follows.
   

Procedure for creating operation of class from object

To create operation of class as stimulus's receiver from object and assign it to stimulus,

1. Double-click stimulus, click button at the quick dialog.
   
2. Enter new operation name to be created, and click [OK] button.
   
3. New operation is added to the class and text is filled at the quick dialog (This procedure is valid when there exists assigned class.). Press [Enter] key.
   
4. See [model explorer] to confirm creation of new operation.
    

Procedure for creating previous stimulus of current stimulus by using shortcut creation syntax

In order to create previous stimulus to current stimulus,

1. Double-click a stimulus, or select a stimulus and press [Enter] key.
   
2. At the quick dialog, After "~>" string("<~" for incoming stimulus), enter target object name and stimulus name.
   
3. Press [Enter] key, and then new object and stimulus are created and arranged above selected stimulus.
   

Procedure for creating next stimulus to current stimulus by using shortcut creation syntax

In order to create next stimulus to selected stimulus,

1. Double-click a stimulus, or select a stimulus and press [Enter] key.
   
2. At the quick dialog, After "_>" string("<_" for incoming stimulus), enter target object name and stimulus name.
   
3. Press [Enter] key, and then new object and stimulus are created and arranged next to selected stimulus.
   

Procedure for creating sub stimulus by using shortcut creation syntax

In order to create a sub stimulus of selected stimulus,

1. Double-click a stimulus, or select a stimulus and press [Enter] key.
   
2. At the quick dialog, After "->" string("<-" for incoming stimulus), enter target object name and sub stimulus name.
   
3. Press [Enter] key, and then new object and stimulus are created and arranged on the bottom of selected stimulus's activation.
   

Procedure for reconnecting to another object

In order to reconnect stimulus to another object,

1. Click the end of stimulus.
   
2. Drag the end of stimulus and drop it to another object.
   
3. Then stimulus will be connected to another object.
   

Procedure for changing ActionKind of stimulus

The [ActionKind] property of stimulus should be assigned to one of five sort as following. To change [ActionKind] property, select stimulus and select the [ActionKind] property on the properties window.

ActionKind	Shape
CALL
SEND
RETURN
CREATE
DESTROY

SelfStimulus

Procedure for creating self-stimulus

In order to create self-stimulus,

1. Click [Toolbox] -> [Sequence] -> [SelfStimulus] button.
   
2. And click the object(or lifeline) that self-stimulus will be placed in the [main window].
   
3. Object quick dialog is opened. At the quick dialog, enter the stimulus name and press [Enter] key.
   
4. The result of procedure is as follows. You may arrange stimulus position to reduce overlapping of text and line.
   

Combined Fragment

Procedure for creating combined fragment

In order to create Combined Fragment,

1. Click [Toolbox] -> [Sequence] -> [Combined Fragment] button.
   
2. And click at the position where Combined Fragment will be placed in the [main window].
   
3. A combined fragment is created.
   
4. Change interaction operator in the properties as follows.
   
5.  The combined fragment is shown as follows.
   

Procedure for creating interaction operand

In order to create Interaction Operand,

1. Click [Toolbox] -> [Sequence] -> [Interaction Operand] button.
   
2. And click at the Combined Fragment where Interaction Operand will be placed in the [main window].
   
3. New interaction operand is added to the combined fragment. Click the interaction operand.
   
4. The selection points of interaction operand are shown, drag it to arrange its boundary.
   

Frame

Procedure for creating frame

In order to create Frame,

1. Click [Toolbox] -> [Sequence] -> [Frame] button.
   
2. And click at the position where Frame will be placed in the [main window].
   
3. A new frame is created as follows.
   

Diagram

Procedure for showing sequence numbers in the diagram

In order to show or hide stimulus sequence number,

1. Select the diagram in the [model explorer] or in the [main window]
   
2. And configure [ShowSequenceNumber] property of diagram to true or false.
   
3. When [ShowSequenceNumber] is false, sequence diagram is shown as follows.
   

Procedure for changing signature style of message in the diagram

There are four message style. To change stimulus signature, select the diagram in the [model explorer] or in the [main window], and configure[MessageSignature] property of diagram to one of the followings.

Style	Example
NONE
NAMEONLY
TYPEONLY
NAMEANDTYPE

Procedure for changing activation style in the diagram

In order to show or hide stimulus activation, select the diagram in the [model explorer] or in the [main window], and configure [ShowActivation] property of diagram to true or false.