------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- Cheddar is a GNU GPL real-time scheduling analysis tool.
-- This program provides services to automatically check schedulability and
-- other performance criteria of real-time architecture models.
--
-- Copyright (C) 2002-2020, Frank Singhoff, Alain Plantec, Jerome Legrand,
--                          Hai Nam Tran, Stephane Rubini
--
-- The Cheddar project was started in 2002 by
-- Frank Singhoff, Lab-STICC UMR 6285, Université de Bretagne Occidentale
--
-- Cheddar has been published in the "Agence de Protection des Programmes/France" in 2008.
-- Since 2008, Ellidiss technologies also contributes to the development of
-- Cheddar and provides industrial support.
--
-- The full list of contributors and sponsors can be found in AUTHORS.txt and SPONSORS.txt
--
-- 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 2 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, write to the Free Software
-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
--
--
-- Contact : cheddar@listes.univ-brest.fr
--
------------------------------------------------------------------------------
-- Last update :
--    $Rev$
--    $Date$
--    $Author: singhoff $
------------------------------------------------------------------------------
------------------------------------------------------------------------------

package queueing_system.theoretical is

   type generic_queueing_system_theoretical is abstract new generic_queueing_system with
   null record;
   type queueing_system_theoretical_ptr is
     access all generic_queueing_system_theoretical'class;

   procedure initialize
     (a_queueing_system : in out generic_queueing_system_theoretical);

   -- reset caracteristics of the qs (has to be done each time a qs is used)
   --
   procedure reset
     (a_queueing_system : in out generic_queueing_system_theoretical);

   -- return the theorec average waiting time of one customer in the queue
   -- based on theorec service time
   --
   procedure qs_average_waiting_time
     (a_queueing_system : in     generic_queueing_system_theoretical;
      result            : in out Double) is abstract;

   -- return the theorec average number of customer in the queue
   -- based on theorec service time
   --
   procedure qs_average_number_customer
     (a_queueing_system : in     generic_queueing_system_theoretical;
      result            : in out Double) is abstract;

   -- return the theorec maximum waiting time of one customer in the queue
   --
   procedure qs_maximum_waiting_time
     (a_queueing_system : in     generic_queueing_system_theoretical;
      result            : in out Double) is abstract;

   -- return the theorec maximum number of customer in the queue
   --
   procedure qs_maximum_number_customer
     (a_queueing_system : in     generic_queueing_system_theoretical;
      result            : in out Double) is abstract;

   -- return theoretical results on qs (waiting time, number of customer)
   --
   procedure theoretical_results
     (a_queueing_system : in generic_queueing_system_theoretical'class;
      message           : in Unbounded_String);

   -- return the probability to be in a certain state
   --
   function get_probability_of_state
     (a_queueing_system : in generic_queueing_system_theoretical;
      n                 : in Natural) return Double is abstract;

   -- return the probability of buffer will be full
   --
   function get_probability_of_full_buffer
     (a_queueing_system : in generic_queueing_system_theoretical)
      return Double;

   -- return the probability of all tasks are busy
   -- Eq. 2.153, Robertazzi: Queueing theory
   --
   function get_probability_of_task_block
     (a_queueing_system : in generic_queueing_system_theoretical)
      return Double;

   --P[queueing], Eq. 2.148, Robertazzi
   --
   function get_probability_of_queueing
     (a_queueing_system : in generic_queueing_system_theoretical)
      return Double;

   --Get probability density of states from 0->N
   --
   function get_probability_density
     (a_queueing_system : in generic_queueing_system_theoretical'class;
      n                 : in Natural := 0) return Double;

end queueing_system.theoretical;