Revision 5f113d7b doc/classdiagrams/overview.uml
| doc/classdiagrams/overview.uml | ||
|---|---|---|
| 25 | 25 |
|
| 26 | 26 |
|
| 27 | 27 |
|
| 28 |
/' Not a type but a set of configuration macros. '/ |
|
| 29 |
class urt_config <<(C,grey)>> {
|
|
| 30 |
'Selection to en-/disable debug checks. |
|
| 31 |
+ URT_CONFIG_DEBUG : bool |
|
| 32 |
'Selector to specify the width of urt_delay_t type. |
|
| 33 |
+ URT_CONFIG_DELAY_WIDTH |
|
| 34 |
'Selector to specify the widtg of the urt_topicid_t type. |
|
| 35 |
+ URT_CONFIG_TOPICID_WIDTH |
|
| 36 |
'Selector to specify the integer type of urt_nodesync_t. |
|
| 37 |
+ URT_CONFIG_NODESYNC_TYPE |
|
| 38 |
} |
|
| 39 |
|
|
| 28 | 40 |
package "primitives" {
|
| 29 | 41 |
|
| 30 | 42 |
/' Temporal delay in microseconds. '/ |
| ... | ... | |
| 34 | 46 |
.. or .. |
| 35 | 47 |
uint64_t |
| 36 | 48 |
} |
| 49 |
urt_delay_t ..> urt_config |
|
| 37 | 50 |
|
| 38 | 51 |
/' Well defined error codes. '/ |
| 39 | 52 |
enum urt_status_t {
|
| ... | ... | |
| 53 | 66 |
.. or .. |
| 54 | 67 |
uint64_t |
| 55 | 68 |
} |
| 69 |
urt_topicid_t ..> urt_config |
|
| 56 | 70 |
|
| 57 | 71 |
/' Just a function for debugging. '/ |
| 58 | 72 |
class urt_debug <<(F,white)>> {
|
| ... | ... | |
| 79 | 93 |
.. or .. |
| 80 | 94 |
int64_t |
| 81 | 95 |
} |
| 96 |
urt_nodesync_t ..> urt_config |
|
| 82 | 97 |
|
| 83 | 98 |
} /' package "primitives" '/ |
| 84 | 99 |
|
| 85 | 100 |
|
| 86 | 101 |
|
| 87 |
package "interfaces" {
|
|
| 88 |
|
|
| 89 |
/' Not a type but a set of configuration macros. '/ |
|
| 90 |
class urt_config <<(C,grey)>> {
|
|
| 91 |
'Selection to en-/disable debug checks. |
|
| 92 |
+ URT_CONFIG_DEBUG : bool |
|
| 93 |
} |
|
| 102 |
package "OSAL" {
|
|
| 94 | 103 |
|
| 95 | 104 |
/' OS time type with arbitrary resolution. '/ |
| 96 | 105 |
class urt_osTime_t <<(T,lightblue)>> {
|
| ... | ... | |
| 103 | 112 |
/' OS mutex lock interface. '/ |
| 104 | 113 |
class urt_osMutex_t <<(T,lightblue)>> {
|
| 105 | 114 |
'Initializes a urt_osMutex_t object. |
| 106 |
+ urtMutexInit (mutex : urt_osmutex_t*) : void
|
|
| 115 |
+ urtMutexInit (mutex : urt_osMutex_t*) : void
|
|
| 107 | 116 |
'Block the thread until the mutex could be locked. |
| 108 |
+ urtMutexLock (mutex : urt_osmutex_t*) : void
|
|
| 117 |
+ urtMutexLock (mutex : urt_osMutex_t*) : void
|
|
| 109 | 118 |
'Tries to lock the mutex, but does not block but immediately returns an indicator. |
| 110 |
+ urtMutexTryLock (mutex : urt_osmutex_t*) : bool
|
|
| 119 |
+ urtMutexTryLock (mutex : urt_osMutex_t*) : bool
|
|
| 111 | 120 |
'Unlocks a previously locked mutex. |
| 112 |
+ urtMutexUnlock (mutex : urt_osmutex_t*) : void
|
|
| 121 |
+ urtMutexUnlock (mutex : urt_osMutex_t*) : void
|
|
| 113 | 122 |
} |
| 114 | 123 |
|
| 115 | 124 |
package "condition variable" {
|
| ... | ... | |
| 157 | 166 |
'Resets the timer. |
| 158 | 167 |
+ urtTimerReset (timer : urt_osTimer_t*) : urt_status_t |
| 159 | 168 |
'Check whether the timer is already armed. |
| 160 |
+ urtTimerIsArmed (timer : urt_timer_t*) : bool
|
|
| 169 |
+ urtTimerIsArmed (timer : urt_osTimer_t*) : bool
|
|
| 161 | 170 |
} |
| 162 | 171 |
urt_osTimer_t ..> urt_delay_t |
| 163 | 172 |
urt_osTimer_t ..> urt_status_t |
Also available in: Unified diff