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 ---Copyright:    Matra Datavision 2003
  25
  26
  27 class CommonBlockAPI from NMTTools
  28
  29         ---Purpose:
  30
  31 uses
  32     ListOfCommonBlock from NMTTools,
  33     ListOfPaveBlock   from BOPTools,
  34     PaveBlock         from BOPTools,
  35     CommonBlock       from NMTTools
  36
  37 --raises
  38
  39 is
  40     Create  (aList:ListOfCommonBlock from NMTTools)
  41         returns CommonBlockAPI from NMTTools;
  42
  43     List(me)
  44         returns  ListOfCommonBlock from NMTTools;
  45     ---C++:  return const &
  46         ---Purpose:
  47         --- Selector
  48         ---
  49     CommonPaveBlocks(me;
  50             anE:Integer from  Standard)
  51         returns  ListOfPaveBlock from BOPTools;
  52     ---C++:  return const &
  53         ---Purpose:
  54         --- Returns all PaveBlock-s (from the list) that are
  55         --- common for the given edge with  DS-index <anE>
  56         ---
  57     IsCommonBlock   (me;
  58             aPB: PaveBlock from BOPTools)
  59         returns  Boolean from Standard;
  60         ---Purpose:
  61         --- Returns TRUE if given PaveBlock <aPB> is
  62         --- common for the Blocks from the list
  63
  64     CommonBlock(me;
  65             aPB: PaveBlock from BOPTools)
  66         returns  CommonBlock from NMTTools;
  67     ---C++:  return &
  68
  69 fields
  70     myListOfCommonBlock  :Address from Standard;
  71     myListOfPaveBlock    :ListOfPaveBlock from BOPTools;
  72
  73 end CommonBlockAPI;