Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / core / urtCoreInit.uml @ e87bd7c7

History | View | Annotate | Download (1.69 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**\nurtCoreInit()\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
  -- //void// --
32
  ====
33
  -- **return** : urt_status_t --
34
  Always returns ""URT_STATUS_OK"".
35
endnote
36 7491c395 Thomas Schöpping
37
/'### PROCEDURE ##############################################################'/
38
39 ee83a495 Thomas Schöpping
start
40 7491c395 Thomas Schöpping
:initialize members;
41 ee83a495 Thomas Schöpping
note
42
  **_nodes** ← ""NULL""
43
  urtEventSourceInit(**_evtSource**)
44
  urtMutexInit(**_lock**)
45 e87bd7c7 Thomas Schöpping
  **_status** ← ""URT_STATUS_OK""
46 ee83a495 Thomas Schöpping
  .. URT_CFG_PUBSUB_ENABLED == true ..
47
  **_topics** ← ""NULL""
48
  .. URT_CFG_RPC_ENABLED == true ..
49
  **_services** ← ""NULL""
50
endnote
51 7491c395 Thomas Schöpping
stop
52
note
53
  Returns ""URT_STATUS_OK"".
54 ee83a495 Thomas Schöpping
endnote
55 7491c395 Thomas Schöpping
56
/'### OUTRO ##################################################################'/
57
58
@enduml