urtware / doc / classdiagrams / config.uml @ 408a606c
History | View | Annotate | Download (2.863 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 | dd31cb03 | Thomas Schöpping | !include ./functions.iuml |
29 | 4d55cea4 | Thomas Schöpping | |
30 | /'### ENTITIES ###############################################################'/ |
||
31 | |||
32 | !startsub ENTITIES |
||
33 | |||
34 | /' Not a type but a set of configuration macros. '/ |
||
35 | $configuration("urt_config") { |
||
36 | 2d315870 | Thomas Schöpping | .. general .. |
37 | 4d55cea4 | Thomas Schöpping | 'Selector to specify the width of urt_delay_t type (32 or 64). |
38 | URT_CFG_DELAY_WIDTH : int |
||
39 | 'Selector to specify the width of the urt_nodestage_t type (8, 16, 32 or 64). |
||
40 | URT_CFG_NODESTAGE_WIDTH : int |
||
41 | 2d315870 | Thomas Schöpping | .. publish-subscribe .. |
42 | 'Flag to en-/disable publush-subscribe functionality. |
||
43 | 4d55cea4 | Thomas Schöpping | URT_CFG_PUBSUB_ENABLED : bool |
44 | 2d315870 | Thomas Schöpping | 'Selector to specify the width of the urt_topicid_t type (8, 16, 32 or 64). |
45 | URT_CFG_PUBSUB_TOPICID_WIDTH : int |
||
46 | 'Flag to en-/disable profiling for publish-subscribe. |
||
47 | 4d55cea4 | Thomas Schöpping | URT_CFG_PUBSUB_PROFILING : bool |
48 | 2d315870 | Thomas Schöpping | 'Flag to en-/disable QoS deadline checks (e.g. timers) for publish-subscribe. |
49 | 4d55cea4 | Thomas Schöpping | URT_CFG_PUBSUB_QOS_DEADLINECHECKS : bool |
50 | 2d315870 | Thomas Schöpping | 'Flag to en-/disable QoS rate checks (e.g. timers) for publish-subscribe. |
51 | 4d55cea4 | Thomas Schöpping | URT_CFG_PUBSUB_QOS_RATECHECKS : bool |
52 | 2d315870 | Thomas Schöpping | 'Flag to en-/disable QoS jitter checks for publish-subscribe. |
53 | 4d55cea4 | Thomas Schöpping | URT_CFG_PUBSUB_QOS_JITTERCHECKS : bool |
54 | 2d315870 | Thomas Schöpping | .. remote procedure calls .. |
55 | 'Flag to en-/disable RPC functionality. |
||
56 | 4d55cea4 | Thomas Schöpping | URT_CFG_RPC_ENABLED : bool |
57 | 2d315870 | Thomas Schöpping | 'Selector to specify the width of the urt_serviceid_t type (8, 16, 32 or 64). |
58 | URT_CFG_RPC_SERVICEID_WIDTH : int |
||
59 | 'Flag to en-/disable profiling of RPCs. |
||
60 | 4d55cea4 | Thomas Schöpping | URT_CFG_RPC_PROFILING : bool |
61 | 2d315870 | Thomas Schöpping | 'Flag to en-/disable QoS deadline checks (e.g. timers) for RPCs. |
62 | URT_CFG_RPC_QOS_DEADLINECHECKS : bool |
||
63 | 'Flag to en-/disable QoS jitter checks for RPCs. |
||
64 | 4d55cea4 | Thomas Schöpping | URT_CFG_RPC_QOS_JITTERCHECKS : bool |
65 | 2d315870 | Thomas Schöpping | .. debug .. |
66 | 'Selection to en-/disable debug checks. |
||
67 | URT_CFG_DEBUG_ENABLED : bool |
||
68 | 4d55cea4 | Thomas Schöpping | } |
69 | |||
70 | !endsub |
||
71 | |||
72 | /'### DEPENDENCIES & LAYOUT ##################################################'/ |
||
73 | |||
74 | !startsub DEPENDENCIES |
||
75 | !endsub |
||
76 | |||
77 | /'### OUTRO ##################################################################'/ |
||
78 | |||
79 | @enduml |