urtware / doc / classdiagrams / primitives.uml @ 056e40d2
History | View | Annotate | Download (2.53 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**\nPrimitives |
27 |
|
28 |
!include ../functions.iuml |
29 |
|
30 |
/'### ENTITIES ###############################################################'/ |
31 |
|
32 |
!startsub ENTITIES |
33 |
|
34 |
/' Node synchronization type. '/ |
35 |
$type("urt_nodestage_t") { |
36 |
.. URT_CFG_NODESTAGE_WIDTH == 8 .. |
37 |
uin8_t |
38 |
.. URT_CFG_NODESTAGE_WIDTH == 16 .. |
39 |
uint16_t |
40 |
.. URT_CFG_NODESTAGE_WIDTH == 32 .. |
41 |
uint32_t |
42 |
.. URT_CFG_NODESTAGE_WIDTH == 64 .. |
43 |
uint64_t |
44 |
} |
45 |
|
46 |
/' Topic ID type. '/ |
47 |
$type("urt_topicid_t") { |
48 |
.. URT_CFG_TOPICID_WIDTH == 8 .. |
49 |
uin8_t |
50 |
.. URT_CFG_TOPICID_WIDTH == 16 .. |
51 |
uint16_t |
52 |
.. URT_CFG_TOPICID_WIDTH == 32 .. |
53 |
uint32_t |
54 |
.. URT_CFG_TOPICID_WIDTH == 64 .. |
55 |
uint64_t |
56 |
} |
57 |
|
58 |
/' Service ID type. '/ |
59 |
$type("urt_serviceid_t") { |
60 |
.. URT_CFG_SERVICEID_WIDTH == 8 .. |
61 |
uin8_t |
62 |
.. URT_CFG_SERVICEID_WIDTH == 16 .. |
63 |
uint16_t |
64 |
.. URT_CFG_SERVICEID_WIDTH == 32 .. |
65 |
uint32_t |
66 |
.. URT_CFG_SERVICEID_WIDTH == 64 .. |
67 |
uint64_t |
68 |
} |
69 |
|
70 |
/' Well defined error codes. '/ |
71 |
$type("urt_status_t") { |
72 |
'No bit set indicates success. |
73 |
URT_STATUS_OK = 0x0..0 |
74 |
'MSB set indicates an error. |
75 |
URT_STATUS_ERROR = 0x8..0 |
76 |
} |
77 |
|
78 |
/' Temporal delay in microseconds. '/ |
79 |
$type("urt_delay_t") { |
80 |
.. URT_CFG_DELAY_WIDTH == 32 .. |
81 |
uint32_t |
82 |
.. URT_CFG_DELAY_WIDTH == 64 .. |
83 |
uint64_t |
84 |
} |
85 |
|
86 |
/' Just a function for debugging. '/ |
87 |
$function("urt_debug") { |
88 |
'Checks the condition in debug mode. |
89 |
+ {method} urtDebugAssert(condition : bool) : void |
90 |
} |
91 |
|
92 |
!endsub |
93 |
|
94 |
/'### DEPENDENCIES & LAYOUT ##################################################'/ |
95 |
|
96 |
!startsub DEPENDENCIES |
97 |
!endsub |
98 |
|
99 |
/'### OUTRO ##################################################################'/ |
100 |
|
101 |
@enduml |
102 |
|