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

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

note

  -- **request** : urt_srtrequest_t* --

  The request to calculate validity for.

  Must not be ""NULL"".

  Must have been acquired before.

  -- **usefulnesscb** : urt_usefulness_f --

  Calback function that calcualtes a usefulness.

  Must not be ""NULL"".

  -- **cbparams** : void* --

  Optional arguments for the callback function.

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

  ====

  -- **return** : float --

  Value in range [0,1], indicating the usefulness of the request.

endnote

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

start

:execute callback function with optional arguments;

stop

note

  Returns callback result.

endnote

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

@enduml