src/NMTTools/NMTTools_FaceInfo.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_FaceInfo.cdl
  24 -- Created:     Tue Dec  9 12:11:48 2003
  25 -- Author:      Peter KURNEV
  26 --              <pkv@irinox>
  27 --
  28 class FaceInfo from NMTTools
  29
  30         ---Purpose:
  31
  32 uses
  33     MapOfInteger from TColStd,
  34     MapOfPaveBlock from NMTTools
  35 --raises
  36
  37 is
  38
  39     Create
  40         returns FaceInfo from NMTTools;
  41     ---C++: inline
  42     ---C++: alias "virtual ~NMTTools_FaceInfo();"
  43         ---Purpose:
  44         --- Empty contructor
  45         ---
  46
  47     Clear(me:out);
  48         ---Purpose:
  49         ---  Clears the contents
  50
  51     SetIndex(me:out;
  52             theI: Integer from Standard);
  53     ---C++: inline
  54         ---Purpose:
  55         --- Modifier
  56         --- Sets the index of the face <theI>
  57
  58     Index(me)
  59         returns Integer from Standard;
  60     ---C++: inline
  61         ---Purpose:
  62         --- Selector
  63         --- Returns the index of the face
  64     --
  65     -- In
  66     --
  67     PaveBlocksIn(me)
  68         returns MapOfPaveBlock from NMTTools;
  69     ---C++: return const &
  70     ---C++: inline
  71         ---Purpose:
  72         --- Selector
  73         --- Returns the pave blocks of the face
  74         --- that  have state In
  75
  76     ChangePaveBlocksIn(me:out)
  77         returns MapOfPaveBlock from NMTTools;
  78     ---C++: return &
  79     ---C++: inline
  80         ---Purpose:
  81         --- Selector/Modifier
  82         --- Returns the pave blocks
  83         --  of the face
  84         --- that  have state In
  85
  86     VerticesIn(me)
  87         returns MapOfInteger from TColStd;
  88     ---C++: return const &
  89     ---C++: inline
  90         ---Purpose:
  91         --- Selector
  92         --- Returns the list of indices for vertices
  93         --  of the face
  94         --- that have state In
  95
  96     ChangeVerticesIn(me:out)
  97         returns MapOfInteger from TColStd;
  98     ---C++: return &
  99     ---C++: inline
 100         ---Purpose:
 101         --- Selector/Modifier
 102         --- Returns the list of indices for vertices
 103         --  of the face
 104         --- that have state In
 105     --
 106     -- On
 107     --
 108     PaveBlocksOn(me)
 109         returns MapOfPaveBlock from NMTTools;
 110     ---C++: return const &
 111     ---C++: inline
 112         ---Purpose:
 113         --- Selector
 114         --- Returns the pave blocks of the face
 115         --- that  have state On
 116
 117     ChangePaveBlocksOn(me:out)
 118         returns MapOfPaveBlock from NMTTools;
 119     ---C++: return &
 120     ---C++: inline
 121         ---Purpose:
 122         --- Selector/Modifier
 123         --- Returns the pave blocks
 124         --  of the face
 125         --- that  have state On
 126     VerticesOn(me)
 127         returns MapOfInteger from TColStd;
 128     ---C++: return const &
 129     ---C++: inline
 130         ---Purpose:
 131         --- Selector
 132         --- Returns the list of indices for vertices
 133         --  of the face
 134         --- that have state On
 135
 136     ChangeVerticesOn(me:out)
 137         returns MapOfInteger from TColStd;
 138     ---C++: return &
 139     ---C++: inline
 140         ---Purpose:
 141         --- Selector/Modifier
 142         --- Returns the list of indices for vertices
 143         --  of the face
 144         --- that have state On
 145
 146 fields
 147     myIndex       : Integer from Standard is protected;
 148     myPaveBlocksIn: MapOfPaveBlock from NMTTools is protected;
 149     myVerticesIn  : MapOfInteger from TColStd is protected;
 150     myPaveBlocksOn: MapOfPaveBlock from NMTTools is protected;
 151     myVerticesOn  : MapOfInteger from TColStd is protected;
 152
 153 end FaceInfo;
 154
 155
 156
 157
 158
 159
 160
 161