--------------------------------------
------------------------------------------
--                                                                          --
--                           OCARINA COMPONENTS                             --
--                                                                          --
--     O C A R I N A . B U I L D E R . C O M P O N E N T S . F L O W S      --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--               Copyright (C) 2005-2006, GET-Telecom Paris.                --
--                                                                          --
-- Ocarina  is free software;  you  can  redistribute  it and/or  modify    --
-- it under terms of the GNU General Public License as published by the     --
-- Free Software Foundation; either version 2, or (at your option) any      --
-- later version. Ocarina 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 distributed with Ocarina; see file COPYING.   --
-- If not, write to the Free Software Foundation, 51 Franklin Street, Fifth --
-- Floor, Boston, MA 02111-1301, USA.                                       --
--                                                                          --
-- As a special exception,  if other files  instantiate  generics from this --
-- unit, or you link  this unit with other files  to produce an executable, --
-- this  unit  does not  by itself cause  the resulting  executable to be   --
-- covered  by the  GNU  General  Public  License. This exception does not  --
-- however invalidate  any other reasons why the executable file might be   --
-- covered by the GNU Public License.                                       --
--                                                                          --
--                 Ocarina is maintained by the Ocarina team                --
--                       (ocarina-users@listes.enst.fr)                     --
--                                                                          --
------------------------------------------------------------------------------

with Ocarina.Entities.Components.Flows;

package Ocarina.Builder.Components.Flows is

   function Add_Property_Association
     (Flow                 : node_id;
      Property_Association : node_id) return Boolean;
   --  Add a property association to the flow declaration. Flow must
   --  reference a flow implementation or a flow
   --  specification. Property_Association references the property
   --  association. Return True if everything went right, else False.

   function Add_New_Flow_Spec
     (Loc           : location;
      Name          : node_id;
      Comp_Type     : node_id;
      Category      : Ocarina.Entities.Components.Flows.flow_category;
      Source_Flow   : node_id;
      Sink_Flow     : node_id;
      Is_Refinement : Boolean := False) return node_id;
   --  Create a new flow specification inside a component type

   function Add_New_Flow_Implementation
     (Loc           : location;
      Container     : node_id;
      Name          : node_id;
      Category      : Ocarina.Entities.Components.Flows.flow_category;
      In_Modes      : node_id;
      Is_Refinement : Boolean) return node_id;
   --  Create a new flow implementation inside a component
   --  implementation

   function Add_New_End_To_End_Flow_Spec
     (Loc           : location;
      Container     : node_id;
      Name          : node_id;
      In_Modes      : node_id;
      Is_Refinement : Boolean) return node_id;
   --  Create a new end to end flow specification inside a component
   --  implementation

end Ocarina.Builder.Components.Flows;