src/IntTools/IntTools_PntOn2Faces.cdl

   1 -- Created on: 2001-12-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 PntOn2Faces from IntTools
  23
  24         ---Purpose: Contains two points PntOnFace from IntTools and a flag
  25
  26 uses
  27     PntOnFace from IntTools
  28 ---raises
  29
  30 is
  31     Create
  32         returns PntOn2Faces from IntTools;
  33         ---Purpose:
  34         --- Empty constructor
  35         ---
  36
  37     Create(aP1: PntOnFace from IntTools;
  38            aP2: PntOnFace from IntTools);
  39         ---Purpose:
  40         --- Initializes me by two points aP1 and aP2
  41         ---
  42
  43     SetP1 (me:out;
  44         aP1: PntOnFace from IntTools);
  45         ---Purpose:
  46         --- Modifier
  47         ---
  48
  49     SetP2 (me:out;
  50         aP2: PntOnFace from IntTools);
  51         ---Purpose:
  52         --- Modifier
  53         ---
  54
  55     SetValid(me:out;
  56         bF : Boolean from Standard);
  57         ---Purpose:
  58         --- Modifier
  59         ---
  60
  61     P1(me)
  62         returns PntOnFace from IntTools;
  63         ---C++:  return const &
  64         ---Purpose:
  65         --- Selector
  66         ---
  67
  68     P2(me)
  69         returns PntOnFace from IntTools;
  70         ---C++:  return const &
  71         ---Purpose:
  72         --- Selector
  73         ---
  74
  75     IsValid(me)
  76         returns Boolean from Standard;
  77         ---Purpose:
  78         --- Selector
  79         ---
  80
  81 fields
  82
  83     myIsValid : Boolean from Standard;
  84     myPnt1    : PntOnFace from IntTools;
  85     myPnt2    : PntOnFace from IntTools;
  86
  87
  88 end PntOn2Faces;