src/NMTTools/NMTTools_CommonBlockAPI.cdl

   1 -- Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 -- CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 --
   4 -- This library is free software; you can redistribute it and/or
   5 -- modify it under the terms of the GNU Lesser General Public
   6 -- License as published by the Free Software Foundation; either
   7 -- version 2.1 of the License.
   8 --
   9 -- This library is distributed in the hope that it will be useful
  10 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 -- Lesser General Public License for more details.
  13 --
  14 -- You should have received a copy of the GNU Lesser General Public
  15 -- License along with this library; if not, write to the Free Software
  16 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 --
  18 -- See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 --
  20 -- File:        NMTTools_CommonBlockAPI.cdl
  21 -- Created:     Mon Dec 15 11:35:46 2003
  22 -- Author:      Peter KURNEV
  23 --              <pkv@irinox>
  24
  25
  26 class CommonBlockAPI from NMTTools
  27
  28         ---Purpose:
  29
  30 uses
  31     ListOfCommonBlock from NMTTools,
  32     ListOfPaveBlock   from BOPTools,
  33     PaveBlock         from BOPTools,
  34     CommonBlock       from NMTTools
  35
  36 --raises
  37
  38 is
  39     Create  (aList:ListOfCommonBlock from NMTTools)
  40         returns CommonBlockAPI from NMTTools;
  41
  42     List(me)
  43         returns  ListOfCommonBlock from NMTTools;
  44     ---C++:  return const &
  45         ---Purpose:
  46         --- Selector
  47         ---
  48     CommonPaveBlocks(me;
  49             anE:Integer from  Standard)
  50         returns  ListOfPaveBlock from BOPTools;
  51     ---C++:  return const &
  52         ---Purpose:
  53         --- Returns all PaveBlock-s (from the list) that are
  54         --- common for the given edge with  DS-index <anE>
  55         ---
  56     IsCommonBlock   (me;
  57             aPB: PaveBlock from BOPTools)
  58         returns  Boolean from Standard;
  59         ---Purpose:
  60         --- Returns TRUE if given PaveBlock <aPB> is
  61         --- common for the Blocks from the list
  62
  63     CommonBlock(me;
  64             aPB: PaveBlock from BOPTools)
  65         returns  CommonBlock from NMTTools;
  66     ---C++:  return &
  67
  68 fields
  69     myListOfCommonBlock  :Address from Standard;
  70     myListOfPaveBlock    :ListOfPaveBlock from BOPTools;
  71
  72 end CommonBlockAPI;