src/BinTools/BinTools_LocationSet.cdl

   1 -- Created on: 2004-06-15
   2 -- Created by: Sergey ZARITCHNY <szy@opencascade.com>
   3 -- Copyright (c) 2004-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class LocationSet from BinTools
  17
  18         ---Purpose: The class LocationSet stores a set of location in
  19         --          a relocatable state.
  20         --
  21         --          It can be created from Locations.
  22         --
  23         --          It can create Locations.
  24
  25
  26 uses
  27     Location             from TopLoc,
  28     IndexedMapOfLocation from TopLoc
  29
  30 raises
  31     OutOfRange           from Standard
  32
  33 is
  34     Create returns LocationSet from BinTools;
  35         ---Purpose: Returns an empty set of locations.
  36
  37     Clear(me : in out)
  38         ---Purpose: Clears the content of the set.
  39     is static;
  40
  41     Add(me : in out; L : Location from TopLoc) returns Integer
  42         ---Purpose: Incorporate a new Location in the  set and returns
  43         --          its index.
  44     is static;
  45
  46     Location(me; I : Integer) returns Location from TopLoc
  47         ---Purpose: Returns the location of index <I>.
  48         --
  49         ---C++: return const &
  50     raises
  51         OutOfRange from Standard
  52     is static;
  53
  54     Index(me; L : Location from TopLoc) returns Integer
  55         ---Purpose: Returns the index of <L>.
  56     is static;
  57
  58     NbLocations(me) returns Integer
  59         ---Purpose: Returns number of locations.
  60     is static;
  61
  62     Write(me; OS : in out OStream)
  63         ---Purpose: Writes the content of  me  on the stream <OS> in a
  64         --          format that can be read back by Read.
  65     is static;
  66
  67     Read(me : in out; IS : in out IStream)
  68         ---Purpose: Reads the content of me from the  stream  <IS>. me
  69         --          is first cleared.
  70         --
  71     is static;
  72
  73 fields
  74
  75     myMap : IndexedMapOfLocation from TopLoc;
  76
  77 end LocationSet;
  78