src/NMTTools/NMTTools_CommonBlockAPI.cdl

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