0024624: Lost word in license statement in source files
[occt.git] / src / BRepFeat / BRepFeat_RibSlot.cdl
old mode 100755 (executable)
new mode 100644 (file)
index edf76c2..21162ab
@@ -1,22 +1,32 @@
--- File:       BRepFeat_LF.cdl
--- Created:    Wed Oct  8 10:06:11 1997
--- Author:     Olga KOULECHOVA
---             <opt@cleox.paris1.matra-dtv.fr>
----Copyright:   Matra Datavision 1997
+-- Created on: 1997-10-08
+-- Created by: Olga KOULECHOVA
+-- Copyright (c) 1997-1999 Matra Datavision
+-- Copyright (c) 1999-2014 OPEN CASCADE SAS
+--
+-- This file is part of Open CASCADE Technology software library.
+--
+-- This library is free software; you can redistribute it and/or modify it under
+-- the terms of the GNU Lesser General Public License version 2.1 as published
+-- by the Free Software Foundation, with special exception defined in the file
+-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+-- distribution for complete text of the license and disclaimer of any warranty.
+--
+-- Alternatively, this file may be used under the terms of Open CASCADE
+-- commercial license or contractual agreement.
 
 deferred class RibSlot from BRepFeat inherits MakeShape from BRepBuilderAPI
 
-       ---Purpose:  Provides functions to build mechanical features.
-       -- Mechanical features include ribs - protrusions and grooves (or slots) - depressions along
-       -- planar (linear) surfaces or revolution surfaces. The semantics of mechanical features is built
-       -- around giving thickness to a contour. This thickness can either be unilateral - on one side
-       -- of the contour - or bilateral - on both sides.
-       -- As in the semantics of form features, the thickness is defined by construction of shapes
-       -- in specific contexts. The development contexts differ, however,in case of mechanical features.
-       -- Here they include extrusion:
-       -- -   to a limiting face of the basis shape
-       -- -   to or from a limiting plane
-       -- -   to a height.
+        ---Purpose:  Provides functions to build mechanical features.
+            -- Mechanical features include ribs - protrusions and grooves (or slots) - depressions along
+            -- planar (linear) surfaces or revolution surfaces. The semantics of mechanical features is built
+            -- around giving thickness to a contour. This thickness can either be unilateral - on one side
+            -- of the contour - or bilateral - on both sides.
+            -- As in the semantics of form features, the thickness is defined by construction of shapes
+            -- in specific contexts. The development contexts differ, however,in case of mechanical features.
+            -- Here they include extrusion:
+            -- -   to a limiting face of the basis shape
+            -- -   to or from a limiting plane
+            -- -   to a height.
 
 uses Shape                     from TopoDS,
      Face                      from TopoDS,
@@ -38,15 +48,14 @@ uses Shape                     from TopoDS,
      Dir                       from gp,
      StatusError               from BRepFeat,
      --modified by NIZNHY-PKV Thu Mar 21 17:09:08 2002  f 
-     BooleanOperation          from BRepAlgoAPI
+     BooleanOperation          from BRepAlgoAPI
      --modified by NIZNHY-PKV Thu Mar 21 17:09:11 2002  t
-     HistoryCollector          from BOP
 is
 
     Initialize;
     
-       ---Purpose: Redefines the empty constructor.
-       ---C++: inline
+        ---Purpose: Redefines the empty constructor.
+        ---C++: inline
 
 
 ---  Methods redefined from BRepBuilderAPI_MakeShape
@@ -54,222 +63,210 @@ is
     IsDeleted(me : in out ; F: Shape from TopoDS) 
     returns Boolean from Standard 
     is redefined;
-       ---Purpose: Returns true if F a TopoDS_Shape of type edge or face has been deleted.   
+            ---Purpose: Returns true if F a TopoDS_Shape of type edge or face has been deleted.   
     
     Modified(me: in out; F: Shape from TopoDS)
-       ---Purpose: Returns the list of generated Faces F. This list may be empty.
-       ---C++:     return const &
+            ---Purpose: Returns the list of generated Faces F. This list may be empty.
+            ---C++:     return const &
     returns ListOfShape from TopTools
     is redefined;
     
 
     Generated(me: in out; S: Shape from TopoDS)
-       ---Purpose: Returns a list TopTools_ListOfShape of the faces S created in the shape.
-       ---C++:     return const &
+            ---Purpose: Returns a list TopTools_ListOfShape of the faces S created in the shape.
+        ---C++:     return const &
     returns ListOfShape from TopTools
     is redefined;
 
 
     FirstShape (me)
-       ---Purpose: Returns the list  of shapes created  at the bottom  of
-       --          the created form.  It may be an empty list.
+            ---Purpose: Returns the list  of shapes created  at the bottom  of
+            --          the created form.  It may be an empty list.
     returns ListOfShape from TopTools;
-       ---C++: return const&
+             ---C++: return const&
 
 
     LastShape (me)
-       ---Purpose: Returns  the list of shapes  created at the top of the
-       --          created form.  It may be an empty list.
+            ---Purpose: Returns  the list of shapes  created at the top of the
+            --          created form.  It may be an empty list.
     returns ListOfShape from TopTools;
-       ---C++: return const&
+             ---C++: return const&
 
     LFPerform(me: in out)
-       ---Purpose: General perform method...
+            ---Purpose: General perform method...
 
-       is static protected;
+            is static protected;
 
     FacesForDraft(me)
-       ---Purpose: Returns a list of the limiting and glueing faces
-       -- generated by the feature. These faces did not originally exist in the basis shape.
-       -- The list provides the information necessary for
-       -- subsequent addition of a draft to a face. It may be an empty list.
-       -- If a face has tangent edges, no draft is possible, and the tangent edges must
-       -- subsequently be removed if you want to add a draft to the face.
+            ---Purpose: Returns a list of the limiting and glueing faces
+            -- generated by the feature. These faces did not originally exist in the basis shape.
+            -- The list provides the information necessary for
+            -- subsequent addition of a draft to a face. It may be an empty list.
+            -- If a face has tangent edges, no draft is possible, and the tangent edges must
+            -- subsequently be removed if you want to add a draft to the face.
     returns ListOfShape from TopTools;
-       ---C++: return const&
+             ---C++: return const&
 
     NewEdges(me)
-       ---Purpose: Returns a list of the limiting and glueing edges
-       -- generated by the feature. These edges did not originally exist in the basis shape.
-       -- The list provides the information necessary for
-       -- subsequent addition of fillets. It may be an empty list.
+            ---Purpose: Returns a list of the limiting and glueing edges
+            -- generated by the feature. These edges did not originally exist in the basis shape.
+            -- The list provides the information necessary for
+            -- subsequent addition of fillets. It may be an empty list.
     returns ListOfShape from TopTools;
-       ---C++: return const&
+             ---C++: return const&
 
     TgtEdges(me)
-       ---Purpose: Returns a list of the tangent edges among the
-       -- limiting and glueing edges generated by the
-       -- feature. These edges did not originally exist in
-       -- the basis shape and are tangent to the face
-       -- against which the feature is built.
-       -- The list provides the information necessary for
-       -- subsequent addition of fillets. It may be an empty list.
-       -- If an edge is tangent, no fillet is possible, and
-       -- the edge must subsequently be removed if you want to add a fillet.
+            ---Purpose: Returns a list of the tangent edges among the
+            -- limiting and glueing edges generated by the
+            -- feature. These edges did not originally exist in
+            -- the basis shape and are tangent to the face
+            -- against which the feature is built.
+            -- The list provides the information necessary for
+            -- subsequent addition of fillets. It may be an empty list.
+            -- If an edge is tangent, no fillet is possible, and
+            -- the edge must subsequently be removed if you want to add a fillet.
     returns ListOfShape from TopTools;
-       ---C++: return const&
+             ---C++: return const&
 
     CheckPoint(me: in out;
-              e        : Edge  from TopoDS;
-              bnd      : Real  from Standard;
-              Pln      : Plane from Geom)
+                   e        : Edge  from TopoDS;
+               bnd      : Real  from Standard;
+               Pln      : Plane from Geom)
     returns Pnt from gp
     is static protected;
 
 
     Normal(me: in out;
-          F : Face from TopoDS;
-          P : Pnt from gp)
+               F : Face from TopoDS;
+           P : Pnt from gp)
     returns Dir from gp
     is static protected;
     
-       
+            
     IntPar(myclass; 
-          C    : Curve from Geom;
-          P    : Pnt   from gp)
+               C    : Curve from Geom;
+           P    : Pnt   from gp)
     returns Real from Standard;
     
     
     EdgeExtention(me: in out;
-                 e         : in out Edge from TopoDS;
-                 bnd       : Real from Standard;
-                 FirstLast : Boolean from Standard)
+                          e         : in out Edge from TopoDS;
+                  bnd       : Real from Standard;
+                  FirstLast : Boolean from Standard)
     is static protected;
     
     
     ChoiceOfFaces(myclass;
-                 faces : in out ListOfShape from TopTools;
-                 cc    : Curve from Geom;
-                 par   : Real  from Standard;
-                 bnd   : Real  from Standard;
-                 Pln   : Plane from Geom)
+                          faces : in out ListOfShape from TopTools;
+                  cc    : Curve from Geom;
+                  par   : Real  from Standard;
+                  bnd   : Real  from Standard;
+                  Pln   : Plane from Geom)
     returns Face from TopoDS;
 
 
     HeightMax(me: in out; 
-             theSbase  : Shape from TopoDS;
-             theSUntil : Shape from TopoDS;
-             p1        : in out Pnt   from gp;
-             p2        : in out Pnt   from gp)
+                  theSbase  : Shape from TopoDS;
+              theSUntil : Shape from TopoDS;
+              p1        : in out Pnt   from gp;
+              p2        : in out Pnt   from gp)
     returns Real from Standard
     is static protected;
-       
+        
     ExtremeFaces(me: in out;
-                RevolRib  : Boolean from Standard;
-                bnd       : Real    from Standard;
-                Pln       : Plane   from Geom;
-                FirstEdge : in out Edge from TopoDS;
-                LastEdge  : in out Edge from TopoDS;
-                FirstFace : in out Face from TopoDS;
-                LastFace  : in out Face from TopoDS;
-                FirstVertex : in out Vertex  from TopoDS;
-                LastVertex  : in out Vertex  from TopoDS;
-                OnFirstFace : in out Boolean from Standard;
-                OnLastFace  : in out Boolean from Standard;
-                PtOnFirstEdge : in out Boolean from Standard;
-                PtOnLastEdge  : in out Boolean from Standard;
-                OnFirstEdge : in out Edge from TopoDS;
-                OnLastEdge  : in out Edge from TopoDS)                 
+                         RevolRib  : Boolean from Standard;
+                 bnd       : Real    from Standard;
+                 Pln       : Plane   from Geom;
+                 FirstEdge : in out Edge from TopoDS;
+                 LastEdge  : in out Edge from TopoDS;
+                 FirstFace : in out Face from TopoDS;
+                 LastFace  : in out Face from TopoDS;
+                 FirstVertex : in out Vertex  from TopoDS;
+                 LastVertex  : in out Vertex  from TopoDS;
+                 OnFirstFace : in out Boolean from Standard;
+                 OnLastFace  : in out Boolean from Standard;
+                 PtOnFirstEdge : in out Boolean from Standard;
+                 PtOnLastEdge  : in out Boolean from Standard;
+                 OnFirstEdge : in out Edge from TopoDS;
+                 OnLastEdge  : in out Edge from TopoDS)                        
     returns Boolean from Standard
     is static protected;
     
-       
+             
     PtOnEdgeVertex(me: in out;
-                  RevolRib  : Boolean from Standard;
-                  shape     : Shape   from TopoDS;
-                  point     : Pnt     from gp;
-                  FirstVertex : Vertex  from TopoDS;
-                  LastVertex  : Vertex  from TopoDS;
-                  PtOnEdge  : in out Boolean from Standard;
-                  OnEdge    : in out Edge    from TopoDS;
-                  PtOnVertex  : in out Boolean from Standard;
-                  OnVertex    : in out Vertex  from TopoDS)
+                           RevolRib  : Boolean from Standard;
+                   shape     : Shape   from TopoDS;
+                   point     : Pnt     from gp;
+                   FirstVertex : Vertex  from TopoDS;
+                   LastVertex  : Vertex  from TopoDS;
+                   PtOnEdge  : in out Boolean from Standard;
+                   OnEdge    : in out Edge    from TopoDS;
+                   PtOnVertex  : in out Boolean from Standard;
+                   OnVertex    : in out Vertex  from TopoDS)
     is static protected;
     
     
     SlidingProfile(me: in out;
-                  Prof      : in out Face from TopoDS;
-                  RevolRib  : Boolean from Standard;
-                  myTol     : Real from Standard;
-                  Concavite : in out Integer from Standard;
-                  myPln     : Plane   from Geom;
-                  BndFace   : Face from TopoDS;
-                  CheckPnt  : Pnt  from gp;
-                  FirstFace : Face from TopoDS;
-                  LastFace  : Face from TopoDS;
-                  FirstVertex : Vertex  from TopoDS;
-                  LastVertex  : Vertex  from TopoDS;
-                  FirstEdge : Edge from TopoDS;
-                  LastEdge  : Edge from TopoDS)
+                           Prof      : in out Face from TopoDS;
+                   RevolRib  : Boolean from Standard;
+                   myTol     : Real from Standard;
+                   Concavite : in out Integer from Standard;
+                   myPln     : Plane   from Geom;
+                   BndFace   : Face from TopoDS;
+                   CheckPnt  : Pnt  from gp;
+                   FirstFace : Face from TopoDS;
+                   LastFace  : Face from TopoDS;
+                   FirstVertex : Vertex  from TopoDS;
+                   LastVertex  : Vertex  from TopoDS;
+                   FirstEdge : Edge from TopoDS;
+                   LastEdge  : Edge from TopoDS)
     returns Boolean from Standard
     is static protected;
     
-       
+        
     NoSlidingProfile(me: in out;
-                    Prof      : in out Face from TopoDS;
-                    RevolRib  : Boolean from Standard;
-                    myTol     : Real from Standard;
-                    Concavite : in out Integer from Standard;
-                    myPln     : Plane   from Geom;
-                    bnd       : Real from Standard;
-                    BndFace   : Face from TopoDS;
-                    CheckPnt  : Pnt  from gp;
-                    FirstFace : Face from TopoDS;
-                    LastFace  : Face from TopoDS;
-                    FirstVertex : Vertex  from TopoDS;
-                    LastVertex  : Vertex  from TopoDS;
-                    FirstEdge : Edge from TopoDS;
-                    LastEdge  : Edge from TopoDS;
-                    OnFirstFace : Boolean from Standard;
-                    OnLastFace  : Boolean from Standard)
+                             Prof      : in out Face from TopoDS;
+                     RevolRib  : Boolean from Standard;
+                     myTol     : Real from Standard;
+                     Concavite : in out Integer from Standard;
+                     myPln     : Plane   from Geom;
+                     bnd       : Real from Standard;
+                     BndFace   : Face from TopoDS;
+                     CheckPnt  : Pnt  from gp;
+                     FirstFace : Face from TopoDS;
+                     LastFace  : Face from TopoDS;
+                     FirstVertex : Vertex  from TopoDS;
+                     LastVertex  : Vertex  from TopoDS;
+                     FirstEdge : Edge from TopoDS;
+                     LastEdge  : Edge from TopoDS;
+                     OnFirstFace : Boolean from Standard;
+                     OnLastFace  : Boolean from Standard)
     returns Boolean from Standard
     is static protected;
     
-       
+        
     UpdateDescendants(me: in out; G: Gluer from LocOpe)
     
     is static protected;
-       ---Purpose: Updates the data structures of descendant
-       -- shapes during the glueing operation.Returns the modified, generated
-       --   and deleted faces during the course of the glueing operation.
+            ---Purpose: Updates the data structures of descendant
+            -- shapes during the glueing operation.Returns the modified, generated
+            --   and deleted faces during the course of the glueing operation.
 
     UpdateDescendants(me: in out; 
                        B        : HBuilder from TopOpeBRepBuild;
-                      SResult  : Shape    from TopoDS;
+                       SResult  : Shape    from TopoDS;
                        SkipFace : Boolean  from Standard = Standard_False)
     
     is static protected;
  
 --modified by NIZNHY-PKV Thu Mar 21 18:42:53 2002  f
     UpdateDescendants(me: in out;  
-              aBOP: BooleanOperation from BRepAlgoAPI;   
-              SResult  : Shape    from TopoDS;
+                   aBOP: BooleanOperation from BRepAlgoAPI;   
+               SResult  : Shape    from TopoDS;
                SkipFace : Boolean  from Standard = Standard_False)
-       is static protected;
+            is static protected;
 --modified by NIZNHY-PKV Thu Mar 21 18:42:50 2002  t
 
-    UpdateDescendants(me: in out;  
-              aBOP: HistoryCollector from BOP;   
-              SResult  : Shape    from TopoDS;
-               SkipFace : Boolean  from Standard = Standard_False)
-       is static protected;
-       ---Purpose: Updates the data structures of descendant
-       -- shapes during the glueing operation.
-       --   Returns the modified, generated and deleted faces during the course of the
-       --   glueing operation; furnishes the arguments of the resulting shape SResult using the
-       --   builder B to determine the type of modification such as orientation and splitting;
-       --   checks to see that the SResult belongs to the data structure of the original shape.
-        
     CurrentStatusError(me)
     returns StatusError from BRepFeat;