------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- 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;