Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / request / srtrequest / urtSrtRequestCalculateUsefulness.uml @ 2d315870

History | View | Annotate | Download (1.87 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**\nurtSrtRequestCalculateUsefulness()\n
27

    
28
/'### PARAMETERS & RETURN ####################################################'/
29

    
30
note
31
  -- **request** : urt_srtrequest_t* --
32
  The request to calculate validity for.
33
  Must not be ""NULL"".
34
  Must have been acquired before.
35
  -- **usefulnesscb** : urt_usefulness_f --
36
  Calback function that calcualtes a usefulness.
37
  Must not be ""NULL"".
38
  -- **cbparams** : void* --
39
  Optional arguments for the callback function.
40
  May be ""NULL"" if the callback does not expect any parameters.
41
  ====
42
  -- **return** : float --
43
  Value in range [0,1], indicating the usefulness of the request.
44
endnote
45

    
46
/'### PROCEDURE ##############################################################'/
47

    
48
start
49
:execute callback function with optional arguments;
50
stop
51
note
52
  Returns callback result.
53
endnote
54

    
55
/'### OUTRO ##################################################################'/
56

    
57
@enduml