Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtFrtSubscriberCalculateValidity.uml @ e87bd7c7

History | View | Annotate | Download (1.768 KB)

1 7491c395 Thomas Schöpping
/'
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 ee83a495 Thomas Schöpping
title **µRtWare**\nurtFrtSubscriberCalculateValidity()\n
27 7491c395 Thomas Schöpping
28 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
29 7491c395 Thomas Schöpping
30
note
31 ee83a495 Thomas Schöpping
  -- **subscriber** : urt_frtsubscriber_t* --
32
  The FRT subscriber to calculate a validity for.
33 7491c395 Thomas Schöpping
  Must not be ""NULL"".
34 ee83a495 Thomas Schöpping
  -- **latency** : urt_delay_t --
35
  Latency (of a message) as argument to calculate validity.
36
  ====
37
  -- **return** : bool --
38
  Returns an indicator whether the latency is fine.
39
endnote
40 7491c395 Thomas Schöpping
41
/'### PROCEDURE ##############################################################'/
42
43 ee83a495 Thomas Schöpping
start
44
if (Latency is lower than the deadline offset and within allowed jitter?) then (yes)
45
  stop
46
  note
47
    Returns ""true"".
48
  endnote
49
else (no)
50
  stop
51
  note
52
    Returns ""false"".
53
  endnote
54
endif
55 7491c395 Thomas Schöpping
56
/'### OUTRO ##################################################################'/
57
58
@enduml