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


with Framework_Config;      use Framework_Config;
with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
with memories;               use memories;
with sets;

package Memory_Set is

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

    package Generic_Memory_Set is new sets (max_element    => Framework_Config.Max_Memories,
                                            element        => Generic_Memory_Ptr,
                                            free           => Free,
                                            copy           => Copy,
                                            put            => Put,
                                            xml_string     => XML_String,
                                            xml_ref_string => XML_Ref_String);
    use Generic_Memory_Set;

    type Memories_Set is new Generic_Memory_Set.set with private;

    subtype Memories_Range is Generic_Memory_Set.element_range;
    subtype Memories_Iterator is Generic_Memory_Set.iterator;

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

    -- Raised when a given Memory is not in a memory set
    --
    Memory_Not_Found : exception;

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


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

    procedure Check_Memory
      (My_memories        : in memories_Set;
       Name               : in Unbounded_String;
       A_Memory_Record    : in Memory_Record);

    procedure Add_Memory
      (My_memories              : in out memories_Set;
       A_Memory                 : in out Generic_Memory_Ptr;
       Name                     : in Unbounded_String;
       A_Memory_Record          : in Memory_Record);

    procedure Add_Memory
      (My_memories        : in out memories_Set;
       Name               : in Unbounded_String;
       A_Memory_Record    : in Memory_Record);

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

    function Search_memory_by_id
      (My_memories : in memories_Set;
       id : in Unbounded_String)
       return          generic_memory_Ptr;

    function Search_Memory
      (My_Memories : in Memories_Set;
       Name       : in Unbounded_String)
       return       Generic_Memory_Ptr;


private

    type Memories_Set is new Generic_Memory_Set.set with null record;

end Memory_Set;