Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / topic / urtTopicInit.uml @ 7491c395

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

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

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

    
32
start
33
note
34
  -- ""**topic** : urt_topic_t*"" --
35
  The topic to initialize.
36
  Must not be ""NULL"".
37
  -- ""**id** : urt_topicid_t"" --
38
  Unique, numeric identifier of the topic.
39
end note
40

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

    
43
:initialize members;
44
:lock core;
45
:insert self to global topic list;
46
:unlock core;
47

    
48
/'### STOP & RETURN ##########################################################'/
49

    
50
stop
51
note
52
  -- **return** ""urt_status_t"" --
53
  Returns ""URT_STATUS_ERROR"" if another topic with the same identifier already exists.
54
end note
55

    
56
/'### OUTRO ##################################################################'/
57

    
58
@enduml