src/BOPTools/BOPTools_Interference.cdl

   1 -- Created on: 2000-11-21
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2000-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class Interference from BOPTools
  23
  24         ---Purpose: class for storing information about an interference
  25         ---         that  takes  place  between  given  shape and shape
  26         ---         with  DS-index =aWith
  27
  28
  29 uses
  30     KindOfInterference from BooleanOperations
  31
  32 is
  33     Create
  34         returns Interference from BOPTools;
  35         ---Purpose:
  36         --- Empty constructor
  37         ---
  38     Create  (aWith   :Integer from Standard;
  39              aType   :KindOfInterference from BooleanOperations;
  40              anIndex :Integer from Standard)
  41         returns Interference from BOPTools;
  42         ---Purpose:  constructor
  43         --- aWith  -  DS-index for the opposite shape
  44         --- aType  -  the type of the  interference
  45         --- anIndex-  the index of the result in corresponding
  46         --- interference table  (if the result is computed
  47         --- but there is no result  ->   anIndex=0)
  48         ---
  49     SetWith  (me:out; aWith :Integer from Standard);
  50         ---Purpose:
  51         --- Modifier
  52         ---
  53     SetType  (me:out; aType : KindOfInterference from BooleanOperations);
  54         ---Purpose:
  55         --- Modifier
  56         ---
  57     SetIndex (me:out; anIndex  :Integer from Standard);
  58         ---Purpose:
  59         --- Modifier
  60         ---
  61     With  (me)
  62         returns Integer from Standard;
  63         ---Purpose:
  64         --- Selector
  65         ---
  66     Type  (me)
  67         returns  KindOfInterference from BooleanOperations;
  68         ---Purpose:
  69         --- Selector
  70         ---
  71     Index (me)
  72         returns Integer from Standard;
  73         ---Purpose:
  74         --- Selector
  75         ---
  76
  77 fields
  78     myWith        : Integer from Standard;
  79     myType        : KindOfInterference from BooleanOperations;
  80     myIndex       : Integer from Standard;  --< index  in corresp.interference  table
  81
  82
  83 end Interference;