Statistics
| Branch: | Revision:

urtware / doc / classdiagrams / urtware.uml @ 056e40d2

History | View | Annotate | Download (4.97 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**
27

    
28
!include ../functions.iuml
29

    
30
/'### ENTITIES ###############################################################'/
31

    
32
!startsub ENTITIES
33

    
34
/' uRtWare core structure. '/
35
$structure("urt_core_t") {
36
    'List of nodes ordered by their (initial) priority.
37
  - {field} {static} _nodes : urt_node_t*
38
    'Event source for control events.
39
  - {field} {static} _evtSource : urt_osEventSource_t
40
    'Mutex used for synchronization.
41
  - {field} {static} _lock : urt_osMutex_t
42
  .. URT_CFG_PUBSUB_ENABLED == true ..
43
    'List of topics ordered by their identifiers.
44
  - {field} {static} _topics : urt_topic_t*
45
  .. URT_CFG_RPC_ENABLED == true ..
46
    'List of services ordered by their identifiers.
47
  - {field} {static} _services : urt_service_t*
48
  __
49
    'Initializes the urt_core_t object.
50
  + {method} urtCoreInit (void) : urt_status_t
51
    'Starts all node threads (nodes will block before the loop).
52
  + {method} urtCoreStartNodes (void) : urt_status_t
53
    'Nodes can use this function to synchronize globally.
54
  + {method} urtCoreSynchronizeNodes (node : urt_node_t*, stage : urt_nodestage_t) : urt_status_t
55
    'Stops all nodes.
56
  + {method} urtCoreStopNodes (void) : urt_status_t
57
  .. URT_CFG_PUBSUB_ENABLED == true ..
58
    'Retrieves a topic given an identifier.
59
  + {method} urtCoreRetrieveTopic (id : urt_topicid_t) : urt_topic_t*
60
  .. URT_CFG_RPC_ENABLED == true ..
61
    'Retrieves a service given an identifier.
62
  + {method} urtCoreRetrieveService (id : urt_serviceid_t) : urt_service_t*
63
}
64

    
65
$group("node") {
66
  /' Function type to be called during setup phase of node threads. '/
67
  $type("urt_nodeSetupCallback_t") {
68
      'Takes the node and optional parameters as arguments and returns a event mask for the next iteration.
69
    urt_nodeSetupCallback_t (node : urt_node_t*, arg : void*) : urt_osEventMask_t
70
  }
71

    
72
  /' Function type to be called during loop phase of node threads. '/
73
  $type("urt_nodeLoopCallback_t") {
74
      'Takes the node, a mask of occurred events and optional parameters as arguments and returns a event mask for the next iteration.
75
    urt_nodeLoopCallback_t (node : urt_node_t*, events : urt_osEventMask_t, arg : void*) : urt_osEventMask_t
76
  }
77

    
78
  /' Node structure. '/
79
  $structure("urt_node_t") {
80
      'Pointer to the next node in a list.
81
    + {field} next : urt_node_t*
82
      'Pointer to the nore thread.
83
    + {field} thread : urt_osThread_t*
84
      'Callback function to be called during the setup phase.
85
    + {field} setupcallback : urt_nodeSetupCallback_t*
86
      'Optional parameters for the setup callback function.
87
    + {field} setupparams : void*
88
      'Callback function to be called in each loop iteration.
89
    + {field} loopcallback : urt_nodeLoopCallback_t*
90
      'Optional parameters for the loop callback function.
91
    + {field} loopparams : void*
92
      'Execution stage of the node.
93
    + {field} stage : urt_nodestage_t
94
      'Event listener for middleware-wide control events.
95
    + {field} listener : urt_osEventListener_t
96
    __
97
    'The main() function of the node thread.
98
    - {method} {static} _main : urt_osThreadFunction_t
99
      'Initializes an urt_node_t object.
100
    + {method} urtNodeInit (node : urt_node_t*, stacksize : size_t, setupcallback : urt_nodeSetupCallback_t*, setupparams : void*, loopcallback : urt_nodeLoopCallback_t*, loopparams : void*) : urt_status_t
101
  }
102
} /'node'/
103

    
104
$module("Publish-Subscribe System") {
105
  !includesub pubsub.uml!ENTITIES
106
}
107

    
108
$module("Remote Procedure Call System") {
109
  !includesub rpc.uml!ENTITIES
110
}
111

    
112
!endsub
113

    
114
/'### DEPENDENCIES & LAYOUT ##################################################'/
115

    
116
!startsub DEPENDENCIES
117

    
118
urt_node_t "1" o-- "0..1" urt_node_t
119
urt_node_t "1" o-- "1" urt_nodeSetupCallback_t
120
urt_node_t <.. urt_nodeSetupCallback_t
121
urt_node_t "1" o-- "1" urt_nodeLoopCallback_t
122
urt_node_t <.. urt_nodeLoopCallback_t
123

    
124
!includesub pubsub.uml!DEPENDENCIES
125

    
126
!includesub rpc.uml!DEPENDENCIES
127

    
128
urt_core_t "1" o-- "0..1" urt_node_t
129
urt_core_t "1" *-- "0..1" urt_topic_t
130
urt_core_t "1" *-- "0..1" urt_service_t
131

    
132
!endsub
133

    
134
/'### OUTRO ##################################################################'/
135

    
136
@enduml
137