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

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

note

  -- **node** : urt_node_t* --

  The node to initialize.

  Must not be ""NULL"".

  -- **thread** : urt_osThread_t* --

  The already initialized, exclusive thread for the node.

  Must not be ""NULL"".

  -- **setupcallback** : urt_nodeSetupCallback_t* --

  Callback function to be executed during setup.

  May be ""NULL"" if no setup is required.

  --  **setupparams** : void*--

  Optional parameters for the setup callback function.

  Must be ""NULL"" if no callback is specified.

  May be ""NULL"" if the specified callback does not expect parameters.

  -- **loopcallback** : urt_nodeLoopCallback_t* --

  Callback function to be executed in a loop.

  Must not be ""NULL"".

  -- **loopparams** : void* --

  Optional parameters for the loop callback function.

  May be ""NULL"" if the specified callback does not expect parameters.

  ====

  -- **return** : urt_status_t --

  Always returns ""URT_STATUS_OK"".

endnote

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

start

:initialize members;

note

  **next** ← ""NULL""

  **thread** ← thread

  **setupcallback** ← setupcallback

  **setupparams** ← setupparams

  **loopcallback** ← loopcallback

  **loopparams** ← loopparams

  **stage** ← 0

  urtEventListenerInit(**listener**)

  .. URT_CFG_PUBSUB_PROFILING == true || URT_CFG_RPC_PROFILING = true ..

  **loops** ← 0

endnote

:lock core;

:prepend self to core's list of nodes;

note

  List is not ordered.

endnote

:unlock core;

stop

note

  Returns ""URT_STATUS_OK"".

endnote

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

@enduml