0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_Common.cdl
old mode 100755 (executable)
new mode 100644 (file)
index 92d8e74..678dd57
@@ -1,46 +1,59 @@
 -- Created on: 1993-10-14
 -- Created by: Remi LEQUETTE
 -- Copyright (c) 1993-1999 Matra Datavision
--- Copyright (c) 1999-2012 OPEN CASCADE SAS
+-- Copyright (c) 1999-2014 OPEN CASCADE SAS
 --
--- The content of this file is subject to the Open CASCADE Technology Public
--- License Version 6.5 (the "License"). You may not use the content of this file
--- except in compliance with the License. Please obtain a copy of the License
--- at http://www.opencascade.org and read it completely before using this file.
+-- This file is part of Open CASCADE Technology software library.
 --
--- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
--- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+-- 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.
 --
--- The Original Code and all software distributed under the License is
--- distributed on an "AS IS" basis, without warranty of any kind, and the
--- Initial Developer hereby disclaims all such warranties, including without
--- limitation, any warranties of merchantability, fitness for a particular
--- purpose or non-infringement. Please see the License for the specific terms
--- and conditions governing the rights and limitations under the License.
+-- Alternatively, this file may be used under the terms of Open CASCADE
+-- commercial license or contractual agreement.
 
+class Common from BRepAlgoAPI  
+    inherits BooleanOperation from BRepAlgoAPI
 
-
-
-class Common from BRepAlgoAPI inherits BooleanOperation from BRepAlgoAPI
-
-       ---Purpose: The class Common provides a
-       -- Boolean common operation on a pair of arguments (Boolean Intersection).
-       --  The class Common provides a framework for:
-       -- -           Defining the construction of a common shape;
-       -- -           Implementing the   building algorithm
-       -- -           Consulting the result.
+    ---Purpose:  
+    -- The class provides Boolean common operation
+    -- between arguments and tools (Boolean Intersection).
 
 uses
     Shape from TopoDS, 
     PaveFiller from BOPAlgo
-
-is
+is  
+    Create 
+        returns Common from BRepAlgoAPI;  
+    ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_Common();"  
+    --- Purpose: Empty constructor       
+      
+    Create (PF: PaveFiller from BOPAlgo)
+        returns Common from BRepAlgoAPI;  
+    --- Purpose: Empty constructor  
+    -- <PF> - PaveFiller object that is carried out     
     Create (S1,S2 : Shape from TopoDS)  
-       returns Common from BRepAlgoAPI;  
-       ---Purpose: Constructs a common part for shapes aS1 and aS2 .
+        returns Common from BRepAlgoAPI;  
+    ---Purpose: Constructor with two shapes  
+    -- <S1>  -argument     
+    -- <S2>  -tool     
+    -- <anOperation> - the type of the operation
+    -- Obsolete  
  
-    Create (S1,S2 : Shape from TopoDS; 
-           aDSF:PaveFiller from BOPAlgo)  
-       returns Common from BRepAlgoAPI;
+    Create (S1: Shape from TopoDS; 
+            S2: Shape from TopoDS; 
+            PF: PaveFiller from BOPAlgo)  
+        returns Common from BRepAlgoAPI; 
+    ---Purpose: Constructor with two shapes  
+    -- <S1>  -argument     
+    -- <S2>  -tool    
+    -- <anOperation> - the type of the operation 
+    -- <PF> - PaveFiller object that is carried out  
+    -- Obsolete   
+    
 end Common;
---- Purpose: Constructs a common part for shapes aS1 and aS2 using aDSFiller
+