src/GEOMAlgo/GEOMAlgo_Splitter.cdl

   1 --  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
   2 --
   3 --  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 --
   6 --  This library is free software; you can redistribute it and/or
   7 --  modify it under the terms of the GNU Lesser General Public
   8 --  License as published by the Free Software Foundation; either
   9 --  version 2.1 of the License.
  10 --
  11 --  This library is distributed in the hope that it will be useful,
  12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 --  Lesser General Public License for more details.
  15 --
  16 --  You should have received a copy of the GNU Lesser General Public
  17 --  License along with this library; if not, write to the Free Software
  18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 --
  20 --  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 --
  22
  23 --  File:       GEOMAlgo_Splitter.cdl
  24 --  Created:
  25 --  Author:     Peter KURNEV
  26 --
  27 class Splitter from GEOMAlgo
  28         inherits Builder from GEOMAlgo
  29
  30         ---Purpose: Implementation of Gluing Operation Algorithm (GA)
  31
  32 uses
  33
  34     ShapeEnum from TopAbs,
  35     Shape from TopoDS,
  36     ListOfShape from TopTools,
  37     MapOfShape  from TopTools
  38
  39 --raises
  40
  41 is
  42
  43     Create
  44         ---Purpose:  Empty constructor
  45         returns Splitter from GEOMAlgo;
  46     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_Splitter();"
  47
  48     Clear(me:out)
  49         ---Purpose:  Clears internal fields and arguments
  50         is redefined;
  51
  52     AddTool (me:out;
  53             theShape: Shape from TopoDS)
  54         ---Purpose:  Adds Tool argument theShape of the operation
  55         is virtual;
  56
  57     Tools(me)
  58         ---Purpose:  Returns the arguments of the operation
  59         returns ListOfShape from TopTools;
  60     ---C++: return const &
  61
  62     SetLimit(me:out;
  63             aLimit:ShapeEnum from TopAbs);
  64
  65     Limit(me)
  66         returns ShapeEnum from TopAbs;
  67
  68     SetLimitMode(me:out;
  69             aLimitMode:Integer from Standard);
  70
  71     LimitMode(me)
  72         returns Integer from Standard;
  73
  74     --
  75     --    Protected methods
  76     --
  77     BuildResult(me:out;
  78             theType: ShapeEnum from TopAbs)
  79     ---Purpose: Build the resulting shapes of type theType
  80         is redefined protected;
  81
  82     PostTreat(me:out)
  83     ---Purpose:  Provides post-tratment actions
  84         is redefined protected;
  85
  86     -- =====================================================
  87     --
  88     --  Debug  methods
  89     --
  90     AddToolCompound (me:out;
  91             theShape: Shape from TopoDS);
  92     ---Purpose:  Adds Tool arguments of the operation as
  93     --           shapes of upper level of container shape theShape
  94     -- =====================================================
  95
  96 fields
  97     myTools           : ListOfShape from TopTools is protected;
  98     myMapTools        : MapOfShape  from TopTools is protected;
  99     myLimit           : ShapeEnum   from TopAbs   is protected;
 100     myLimitMode       : Integer from Standard     is protected;
 101
 102 end Splitter;
 103