------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- 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 Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
with Framework_Config;      use Framework_Config;
with Networks;              use Networks;
with sets;




package Network_Set is

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

   package Generic_Network_Set is new Sets (
      Max_Element => Framework_Config.Max_Networks,
      Element => Generic_Network_Ptr,
      Free => Free,
      Copy => Copy,
      Put => Put,
      xml_ref_string => XML_ref_String,
      xml_string => XML_String);
   use Generic_Network_Set;

   type Networks_Set is new Generic_Network_Set.set with private;

   subtype Networks_Range is Generic_Network_Set.element_range;
   subtype Networks_Iterator is Generic_Network_Set.iterator;

   ----------------------------------------------------------
   -- Exceptions defined in the set package
   ----------------------------------------------------------

   -- Raised when a given network is not in a network set
   --
   Network_Not_Found : exception;

   -- Raised when parameters provided to Add_network are wrong
   --
   Invalid_Parameter : exception;


   ----------------------------------------------------------
   -- Table without any processor position
   ----------------------------------------------------------

   No_Position : Positions_Table;


   ----------------------------------------------------------
   -- I/O operations
   ----------------------------------------------------------
   function Export_Aadl_Implementations
     (My_Networks : in Networks_Set)
      return        Unbounded_String;

   function Export_Aadl_Declarations
     (My_Networks  : in Networks_Set;
      Number_Of_Ht : in Natural)
      return         Unbounded_String;

   ----------------------------------------------------------
   -- Procedure to proceed modification on a set
   ----------------------------------------------------------

   procedure Check_network
     (My_networks  : in Networks_Set;
      Name         : in Unbounded_String;
      Network_architecture_Type : in Networks_architecture_Type;
      topology     : in topology_type := mesh_topology;
      link_delay : in integer:=0;
      number_of_processor : in integer:=0;
      dimension : in integer:=0;
      Xdimension : in integer:=0;
      Ydimension : in integer:=0;
      number_of_virtual_channel : in integer:=0;
      Network_Delay : in Networks_Delay_Type := bounded_delay;
      switching_protocol : in switching_type := Wormwole;
      Routing_Protocol : in Routing_Type := XY;
      Processor_Positions : in Positions_Table := No_Position);

   procedure Update_Network
     (My_Networks  : in out Networks_Set;
      Name         : in Unbounded_String;
      Network_Type : in Networks_architecture_Type);

   procedure Add_Network
     (My_Networks  : in out Networks_Set;
      Name         : in Unbounded_String;
      Network_architecture_Type : in Networks_architecture_Type;
      topology     : in topology_type := mesh_topology;
      link_delay : in integer:=0;
      number_of_processor : in integer:=0;
      dimension : in integer:=0;
      Xdimension : in integer:=0;
      Ydimension : in integer:=0;
      number_of_virtual_channel : in integer:=0;
      Network_Delay : in Networks_Delay_Type := bounded_delay;
      switching_protocol : in switching_type := Wormwole;
      Routing_Protocol : in Routing_Type := XY;
      Processor_Positions : in Positions_Table := No_Position);

 procedure Add_Network
     (My_Networks  : in out Networks_Set;
      a_network    :  out generic_network_ptr;
      Name         : in Unbounded_String;
      Network_architecture_Type : in Networks_architecture_Type;
      topology     : in topology_type := mesh_topology;
      link_delay : in integer:=0;
      number_of_processor : in integer:=0;
      dimension : in integer:=0;
      Xdimension : in integer:=0;
      Ydimension : in integer:=0;
      number_of_virtual_channel : in integer:=0;
      Network_Delay : in Networks_Delay_Type := bounded_delay;
      switching_protocol : in switching_type := Wormwole;
      Routing_Protocol : in Routing_Type := XY;
      Processor_Positions : in Positions_Table := No_Position);


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

   function Search_Network
     (My_Networks : in Networks_Set;
      Name        : in Unbounded_String)
      return        generic_Network_Ptr;

private

   type Networks_Set is new Generic_Network_Set.set with null record;

end Network_Set;