AMiRo-OS

/'

µRtWare is a lightweight publish/subscribe middleware for real-time

applications. It was developed as part of the software habitat for the

Autonomous Mini Robot [1] (AMiRo) but can be used for other purposes as well.

Copyright (C) 2018..2020  Thomas Schöpping et al.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see <http://www.gnu.org/licenses/>.

'/

/'### INTRO ##################################################################'/

@startuml

title **µRtWare**\nurtTopicInit()\n

!include ../../functions.iuml

/'### PARAMETERS & START #####################################################'/

start

note

  -- ""**topic** : urt_topic_t*"" --

  The topic to initialize.

  Must not be ""NULL"".

  -- ""**id** : urt_topicid_t"" --

  Unique, numeric identifier of the topic.

end note

/'### PROCEDURE ##############################################################'/

:initialize members;

:lock core;

:insert self to global topic list;

:unlock core;

/'### STOP & RETURN ##########################################################'/

stop

note

  -- **return** ""urt_status_t"" --

  Returns ""URT_STATUS_ERROR"" if another topic with the same identifier already exists.

end note

/'### OUTRO ##################################################################'/

@enduml