urtware / doc / activitydiagrams / subscriber / urtSrtSubscriberCalculateUsefulness.uml @ e87bd7c7
History | View | Annotate | Download (1.78 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**\nurtSrtSubscriberCalculateUsefulness()\n |
27 |
|
28 |
/'### PARAMETERS & RETURN ####################################################'/ |
29 |
|
30 |
note |
31 |
-- **subscriber** : urt_srtsubscriber_t* -- |
32 |
The SRT subscriber to calculate a usefulness for. |
33 |
Must not be ""NULL"". |
34 |
-- **latency** : urt_delay_t -- |
35 |
Latency (of a message) as argument to calculate usefulness. |
36 |
==== |
37 |
-- **return** : float -- |
38 |
Returns the usefulness as a value within [0,1]. |
39 |
endnote |
40 |
|
41 |
/'### PROCEDURE ##############################################################'/ |
42 |
|
43 |
start |
44 |
:execute the subscriber's ""usefulnesscb"" function; |
45 |
note |
46 |
The callback function must never return a negative value or a value greater than 1. |
47 |
endnote |
48 |
stop |
49 |
note |
50 |
Returns callback result value. |
51 |
endnote |
52 |
|
53 |
/'### OUTRO ##################################################################'/ |
54 |
|
55 |
@enduml |