How to model different return values of a function in a UML Activity-Diagram?

Question

See the following code for example. How can I model different return values of a function in a UML Activity-Diagram?

typedef enum {CLOSED, OPEN, UNKNOWN} sw_state_t;

sw_state_t read_input(int index)
{
    uint8_t sw_state;

    if (spi_read(&sw_state) == STATUS_OK) {
       if (sw_state & (1 << index))
           return CLOSED;
       else
           return OPEN;
    }

    return UNKNOWN;
}

What I want to show is the value the function returns. What I have is an Activity block with one input ActivityParameter and one output ActivityParameter.

Update

Does the following diagram make sense?

enter image description here

Aleks · Accepted Answer · 2014-05-09T09:38:16.040

6

Use a data object, as they are output of activities. Then link the object with the activity

Looking at your diagram, just before each relevant ActivityFinal (return OPEN, CLOSED, UNKNOWN) add an action to return the corresponding object the following way. Then connect each object with the OutputParameter.

enter image description here

edited May 09 '14 at 09:38

answered May 09 '14 at 09:02

Aleks

5,674
1
28
54

do you mean an action with a name like "return OPEN"? – sergej May 09 '14 at 09:35
Exactly. Please see the updated diagram... Note that the activity end is now CLOSE, OPEN... instead of "return xxx". That's cleaner and closer to the truth, as ActivityEnd itself does not return anything. It merely marks the kind of the ActivityEnd. – Aleks May 09 '14 at 09:38
Just in case - use ObjectFlow to connect Objects with other elements. – Aleks May 09 '14 at 09:45
in the object node, is `sw_state_t` the object type and `OPEN` the object state? How do I configure it EA? – sergej May 09 '14 at 10:56
2

Add somewhere in model an Enumeration element named sw_state_t (usually it would be a class, but you deal with an enum here). Then just drag&drop it (as instance) on the activity diagram. Finally set the object's name. In my models I always create a class model to specify the domain concepts and their relationships. Later I use classes/objects in other diagrams (like this one). This practice makes a nice traceability between different models and permits more formal and acurete spec. – Aleks May 09 '14 at 11:06

score 1 · Answer 2 · answered May 09 '14 at 09:05

1

I think your diagram is too fine grained. Why do you need the internals?

I'd do it simply like that:

Simple

answered May 09 '14 at 09:05

PsiX

1,661
1
17
35

score 0 · Answer 3 · edited May 23 '17 at 11:58

your example with one function is too small, wider context is missing. What will be the outcomes of the read_input function used for, the follow ups, how does it integrate into the surrounding system. As @PsiX suggests it is probably too fine grained. Without the broader view modeling single small pieces of code does not make much sense.
I'm not an expert myself, still learning → some links to explanations of the activity diagrams that are useful in my opinion, especially Conrad Bock's articles

In your case the way to model the result will depend on the way how you want to model the rest, the wider context.
If you want to concentrate on control flow then you can use e.g. "send signal action" approach. The "send event"/"receive event" modeling is used by ARIS Event-Driven Process Chain (EPC) visual language where it plays important role. I'm not sure how well does it fit into the UML activity diagram concept but it seems to be "legal"
If you want to concentrate on data flow then you can use the way electric circuits work (I believe it is the source of the "pin" concept anyway). The activity will send data token through one of the output pins. It will set one of the output wires high. Set one of the bits, return one enum value.

How to model different return values of a function in a UML Activity-Diagram?

3 Answers3