Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / core / urtCoreAddTopic.uml @ e7056e1b

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

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

    
30
note
31
  -- **topic** : urt_topic_t* --
32
  The topic to append. Must not be NULL.
33
  ====
34
  -- **return** : urt_status_t --
35
  Returns URT_STATUS_OK on success.
36
endnote
37

    
38
/'### PROCEDURE ##############################################################'/
39

    
40
start
41
:lock core;
42
:Access first topic in core's list of topics;
43
while (Next topic is not ""NULL"") is (yes)
44
  :Proceed to next topic;
45
endwhile (no)
46
:Set next pointer of topic to topic to append;
47
:unlock core;
48
stop
49
note
50
  Return URT_STATUS_OK.
51
endnote
52

    
53
/'### OUTRO ##################################################################'/
54

    
55
@enduml