Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtSubscriberCalculateUsefulness.uml @ c22d21ad

History | View | Annotate | Download (2.037 KB)

1
/'
2
µRtWare is a lightweight publish/subscribe middleware for real-time
3
applications. It was developed as part of the software habitat for the
4
Autonomous Mini Robot [1] (AMiRo) but can be used for other purposes as well.
5

    
6
Copyright (C) 2018..2020  Thomas Schöpping et al.
7

    
8
This program is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 3 of the License, or
11
(at your option) any later version.
12

    
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
GNU General Public License for more details.
17

    
18
You should have received a copy of the GNU General Public License
19
along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
'/
21

    
22
/'### INTRO ##################################################################'/
23

    
24
@startuml
25

    
26
title **µRtWare**\nurtSubscriberCalculateUsefulness()\n
27

    
28
!include ../../functions.iuml
29

    
30
/'### PARAMETERS & START #####################################################'/
31

    
32
start
33
note
34
  -- ""**subscriber** : urt_subscriber_t*"" --
35
  The subscriber to be unsubscribed.
36
  Must not be ""NULL"".
37
  -- ""**latency** : urt_delay_t"" --
38
  Delay (of a mesage) to calculate the usefulness for.
39
end note
40

    
41
/'### PROCEDURE ##############################################################'/
42

    
43
if (RT class) then (HRT)
44
  :return ""1"";
45
  note: Otherwise some QoS timer would have triggered.
46
elseif (RT class) then (FRT)
47
  if (Timing ok?) then (yes)
48
  note: ToDo: When is timing ok?
49
    :return ""1.0"";
50
  else (no)
51
    :return ""0.0"";
52
  endif
53
elseif (RT class) then (SRT)
54
  :execute callback;
55
  :return result;
56
else (NRT)
57
  :return ""1"";
58
endif
59

    
60
/'### STOP & RETURN ##########################################################'/
61

    
62
stop
63
note
64
  -- **return** ""float"" --
65
  Returns the usefulness as a value within ""[0,1]"".
66
end note
67

    
68
/'### OUTRO ##################################################################'/
69

    
70
@enduml