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**\nurtCoreGetTopic()\n

/'### PARAMETERS & RETURN ####################################################'/

note

  -- **id** : urt_topicid_t --

  Identifier of the topic to retrieve.

  ====

  -- **return** : urt_topic_t* --

  Returns a pointer to the requested topic.

  Returns ""NULL"" if no topic matches the given ID.

endnote

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

start

:lock core;

:access first topic;

while (Topic ist not ""NULL""\nand topic ID is lower?) is (yes)

  :proceed to next topic;

endwhile (no)

:unlock core;

if (Topic is not ""NULL""\nand topic ID matches?) then (yes)

  stop

  note

    Returns pointer to topic.

  endnote

else (no)

  stop

  note

    Returns ""NULL"".

  endnote

endif

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

@enduml