urtware / doc / classdiagrams / config.uml @ 056e40d2
History | View | Annotate | Download (2.71 KB)
1 | 4d55cea4 | 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 | title **µRtWare**\nConfiguration |
||
27 | |||
28 | !include ../functions.iuml |
||
29 | |||
30 | /'### ENTITIES ###############################################################'/ |
||
31 | |||
32 | !startsub ENTITIES |
||
33 | |||
34 | /' Not a type but a set of configuration macros. '/ |
||
35 | $configuration("urt_config") { |
||
36 | 'Selector to specify the width of urt_delay_t type (32 or 64). |
||
37 | URT_CFG_DELAY_WIDTH : int |
||
38 | 'Selector to specify the width of the urt_topicid_t type (8, 16, 32 or 64). |
||
39 | URT_CFG_TOPICID_WIDTH : int |
||
40 | 'Selector to specify the width of the urt_serviceid_t type (8, 16, 32 or 64). |
||
41 | URT_CFG_SERVICEID_WIDTH : int |
||
42 | 'Selector to specify the width of the urt_nodestage_t type (8, 16, 32 or 64). |
||
43 | URT_CFG_NODESTAGE_WIDTH : int |
||
44 | .. |
||
45 | 'Selection to en-/disable debug checks. |
||
46 | URT_CFG_DEBUG_ENABLED : bool |
||
47 | .. |
||
48 | 'Selection ed-/disable publush-subscribe functionality. |
||
49 | URT_CFG_PUBSUB_ENABLED : bool |
||
50 | 'Selection to en-/disable profiling for publish-subscribe. |
||
51 | URT_CFG_PUBSUB_PROFILING : bool |
||
52 | 'Selection to en-/disable QoS deadline checks (e.g. timers) for publish-subscribe. |
||
53 | URT_CFG_PUBSUB_QOS_DEADLINECHECKS : bool |
||
54 | 'Selection to en-/disable QoS rate checks (e.g. timers) for publish-subscribe. |
||
55 | URT_CFG_PUBSUB_QOS_RATECHECKS : bool |
||
56 | 'Selection to en-/disable QoS jitter checks for publish-subscribe. |
||
57 | URT_CFG_PUBSUB_QOS_JITTERCHECKS : bool |
||
58 | .. |
||
59 | 'Selection to en-/disable RPC functionality. |
||
60 | URT_CFG_RPC_ENABLED : bool |
||
61 | 'Selection to en-/disable profiling of RPCs. |
||
62 | URT_CFG_RPC_PROFILING : bool |
||
63 | 'Selection to en-/disable QoS jitter checks for RPCs. |
||
64 | URT_CFG_RPC_QOS_JITTERCHECKS : bool |
||
65 | } |
||
66 | |||
67 | !endsub |
||
68 | |||
69 | /'### DEPENDENCIES & LAYOUT ##################################################'/ |
||
70 | |||
71 | !startsub DEPENDENCIES |
||
72 | !endsub |
||
73 | |||
74 | /'### OUTRO ##################################################################'/ |
||
75 | |||
76 | @enduml |