src/TopLoc/TopLoc.cdl

   1 -- Created on: 1990-12-19
   2 -- Created by: Christophe MARION
   3 -- Copyright (c) 1990-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23
  24 package TopLoc
  25
  26     ---Level : Public.
  27     --  All methods of all  classes will be public.
  28
  29     ---Purpose: The TopLoc package gives ressources to handle 3D local
  30     --          coordinate systems called Locations.
  31     --
  32     --          A Location  is a composition of  elementary coordinate
  33     --          systems,  each one is  called a  Datum.   The Location
  34     --          keeps track of  this composition.
  35     --
  36
  37 uses
  38     Standard,
  39     MMgt,
  40     TCollection,
  41     gp
  42
  43 is
  44     pointer TrsfPtr to Trsf from gp;
  45     class Datum3D;
  46         ---Purpose: An elementary 3D coordinate system.
  47
  48     private class ItemLocation;
  49         ---Purpose: Used to implement  the Location. A  Datum3D with a
  50         --          power elevation.
  51
  52     private class SListOfItemLocation instantiates
  53         SList from TCollection(ItemLocation from TopLoc);
  54         ---Purpose: Used to implement the Location.
  55
  56     class Location;
  57         ---Purpose: A  Local Coordinate System.   A list of elementary
  58         --          Datums.
  59
  60     class MapLocationHasher instantiates
  61           MapHasher from TCollection(Location from TopLoc);
  62
  63     class MapOfLocation instantiates
  64           Map from TCollection(Location          from TopLoc,
  65                                MapLocationHasher from TopLoc);
  66
  67     class IndexedMapOfLocation instantiates
  68           IndexedMap from TCollection(Location          from TopLoc,
  69                                       MapLocationHasher from TopLoc);
  70
  71 end TopLoc;
  72
  73
  74
  75