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

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

note

  -- **subscriber** : urt_srtsubscriber_t* --

  The SRT subscriber to calculate a usefulness for.

  Must not be ""NULL"".

  -- **latency** : urt_delay_t --

  Latency (of a message) as argument to calculate usefulness.

  ====

  -- **return** : float --

  Returns the usefulness as a value within [0,1].

endnote

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

start

:execute the subscriber's ""usefulnesscb"" function;

note

  The callback function must never return a negative value or a value greater than 1.

endnote

stop

note

  Returns callback result value.

endnote

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

@enduml