src/SMDS/SMDS_MapOfMeshOrientedElement.cdl

   1 -- File:        SMDS_MapOfMeshOrientedElement.cdl
   2 -- Created:     Fri Jan 25 11:39:17 2002
   3 -- Author:      Jean-Michel BOULCOURT
   4 --              <jmb@coulox.paris1.matra-dtv.fr>
   5 ---Copyright:    Matra Datavision 2002
   6
   7
   8 class MapOfMeshOrientedElement from SMDS inherits ExtendedOrientedMap from SMDS
   9
  10         ---Purpose:  Redefinition/definition  of methods of Map from TCollection
  11
  12 uses
  13     MeshElement from SMDS
  14
  15 raises
  16     NoSuchObject from Standard
  17
  18 is
  19     Create(NbBuckets : Integer =1) returns MapOfMeshOrientedElement from SMDS;
  20    ---Purpose: Creates   a Map with  <NbBuckets> buckets. Without
  21    --          arguments the map is automatically dimensioned.
  22    ---C++: inline
  23
  24     Find(me; K : MeshElement) returns MeshElement
  25         ---Level: Public
  26         ---Purpose: Returns  the Item stored  with the Key  <K> in the Map.
  27         ---Trigger: An exception is raised when <K> is not in the map.
  28     raises NoSuchObject from Standard
  29         ---C++: alias operator()
  30         ---C++: return const &
  31     is static;
  32
  33     ChangeFind(me : in out; K : MeshElement) returns MeshElement
  34         ---Level: Public
  35         ---Purpose: Returns the  Item stored with  the Key  <K> in the
  36         -- Map. This Item can be   modified with  the  syntax
  37         -- aMap(K) = newItem;
  38         ---Trigger: An exception is raised when <K> is not in the map.
  39         ---C++: alias operator()
  40         ---C++: return &
  41     raises NoSuchObject from Standard
  42     is static;
  43
  44     FindID(me; ID : Integer) returns MeshElement
  45         ---Level: Public
  46         ---Purpose: Returns  the Item stored  with the ID in the Map.
  47         ---Trigger: An exception is raised when ID is not in the map.
  48     raises NoSuchObject from Standard
  49         ---C++: alias operator()
  50         ---C++: return const &
  51     is static;
  52
  53
  54     ContainsID(me; ID : Integer) returns Boolean
  55         ---Level: Public
  56         ---Purpose: Returns True  if the ID is stored  in the
  57         -- map <me>.
  58     is static;
  59
  60 end MapOfMeshOrientedElement;