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

with framework_config;      use framework_config;
with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
with deployments;           use deployments;
with unbounded_strings;     use unbounded_strings;
with scheduler_interface;   use scheduler_interface;
with objects;               use objects;
use objects.generic_object_set_package;
with sets;

package deployment_set is

   ----------------------------------------------------------
   -- Definition of a set
   ----------------------------------------------------------

   package generic_deployment_set is new sets
     (max_element    => framework_config.max_deployments,
      element        => generic_deployment_ptr,
      free           => free,
      copy           => copy,
      put            => put,
      xml_string     => xml_string,
      xml_ref_string => xml_ref_string);
   use generic_deployment_set;

   type deployments_set is new generic_deployment_set.set with private;

   subtype deployments_range is generic_deployment_set.element_range;
   subtype deployments_iterator is generic_deployment_set.iterator;

   ----------------------------------------------------------
   -- Exceptions defined in the set package
   ----------------------------------------------------------
   -- Raised when a given deployment is not in a deployment set
   --
   deployment_not_found : exception;

   -- Raised when parameters provided to Add_deployment are wrong
   --
   invalid_parameter : exception;

   procedure add_deployment
     (my_deployments         : in out deployments_set;
      a_deployment           : in out generic_deployment_ptr;
      name                   : in     Unbounded_String;
      resource_entities      : in     generic_objects_set;
      consumer_entities      : in     generic_objects_set;
      allocation_description : in     Unbounded_String;
      capacity               : in     Integer          := 0;
      period                 : in     Integer          := 0;
      priority               : in     Integer          := 0;
      is_preemptive          : in     preemptives_type := preemptive;
      quantum                : in     Integer          := 0;
      file_name              : in     Unbounded_String := empty_string;
      a_scheduler            : in schedulers_type  := no_scheduling_protocol;
      automaton_name         : in     Unbounded_String := empty_string);

   procedure add_deployment
     (my_deployments         : in out deployments_set;
      name                   : in     Unbounded_String;
      resource_entities      : in     generic_objects_set;
      consumer_entities      : in     generic_objects_set;
      allocation_description : in     Unbounded_String;
      capacity               : in     Integer          := 0;
      period                 : in     Integer          := 0;
      priority               : in     Integer          := 0;
      is_preemptive          : in     preemptives_type := preemptive;
      quantum                : in     Integer          := 0;
      file_name              : in     Unbounded_String := empty_string;
      a_scheduler            : in schedulers_type  := no_scheduling_protocol;
      automaton_name         : in     Unbounded_String := empty_string);

   procedure check_deployment
     (my_deployments    : in deployments_set;
      name              : in Unbounded_String;
      resource_entities : in generic_objects_set;
      consumer_entities : in generic_objects_set;
      allocation_file   : in Unbounded_String;
      capacity          : in Integer;
      period            : in Integer;
      priority          : in Integer;
      is_preemptive     : in preemptives_type;
      quantum           : in Integer;
      file_name         : in Unbounded_String;
      a_scheduler       : in schedulers_type;
      automaton_name    : in Unbounded_String);

   ------------------------------------------------------
   -- Read information from a set
   ------------------------------------------------------

   function search_deployment
     (my_deployments : in deployments_set;
      name           : in Unbounded_String) return generic_deployment_ptr;

   function search_deployment_by_processor_name
     (my_deployments : in deployments_set;
      name           : in Unbounded_String) return generic_deployment_ptr;

   function search_deployment_by_resource_task_name
     (my_deployments : in deployments_set;
      name           : in Unbounded_String) return generic_deployment_ptr;

   function search_deployment_by_consumer_task_name
     (my_deployments : in deployments_set;
      name           : in Unbounded_String) return generic_deployment_ptr;

   -- Delete a deployment in the set
   --
   procedure delete_deployment
     (my_deployments : in out deployments_set;
      name           : in     Unbounded_String);

private

   type deployments_set is new generic_deployment_set.set with null record;

end deployment_set;