src/BOP/BOP_SFSCorrector.cdl

   1 -- Created on: 2001-04-13
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2001-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 SFSCorrector from BOP
  23
  24         ---Purpose:
  25         ---  the algorithm is to change the Shell Faces Set (SFS)contents.
  26         ---  The NewSFS will contain only shells
  27         ---  instead of shells and faces.
  28         ---
  29
  30 uses
  31
  32     ShellFaceSet         from BOP,
  33     PShellFaceSet        from BOP,
  34     ListOfConnexityBlock from BOP
  35
  36 is
  37     Create
  38         returns SFSCorrector from BOP;
  39         ---Purpose:
  40         --- Empty constructor;
  41         ---
  42     SetSFS  (me:out;
  43                 aSFS: ShellFaceSet from BOP);
  44         ---Purpose:
  45         --- Modifier
  46         ---
  47     Do (me:out);
  48         ---Purpose:
  49         --- Performs the algorithm of  two  steps
  50         --- 1. Make conexity blocks (  DoConnexityBlocks()  )
  51         --- 2. Make corrections     (  DoCorrections()  )
  52         ---
  53     DoConnexityBlocks(me:out)
  54         is  private;
  55         ---Purpose:
  56         --- Internal Purpose
  57         ---
  58     DoCorrections(me:out)
  59         is  private;
  60         ---Purpose:
  61         --- Internal Purpose
  62         ---
  63     IsDone(me)
  64         returns Boolean from Standard;
  65         ---Purpose:
  66         --- Selector
  67         ---
  68     ErrorStatus (me)
  69         returns Integer from Standard;
  70         ---Purpose:
  71         --- Selector
  72         --- - 1 - Nothing is done because only constructor has been called
  73         ---
  74     SFS     (me:out)
  75         returns ShellFaceSet from BOP;
  76         ---C++:  return &
  77         ---Purpose:
  78         --- Selector
  79         ---
  80     NewSFS  (me:out)
  81         returns ShellFaceSet from BOP;
  82         ---C++:  return &
  83         ---Purpose:
  84         --- Selector
  85         --- Returns the resulting SFS
  86         ---
  87
  88 fields
  89
  90     mySFS             : PShellFaceSet        from BOP;
  91     myNewSFS          : ShellFaceSet         from BOP;
  92     myConnexityBlocks : ListOfConnexityBlock from BOP;
  93     myIsDone          : Boolean from Standard;
  94     myErrorStatus     : Integer from Standard;
  95
  96 end SFSCorrector;