src/BOPDS/BOPDS_Pave.cdl

   1 -- Created by: Peter KURNEV
   2 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   3 --
   4 -- The content of this file is subject to the Open CASCADE Technology Public
   5 -- License Version 6.5 (the "License"). You may not use the content of this file
   6 -- except in compliance with the License. Please obtain a copy of the License
   7 -- at http://www.opencascade.org and read it completely before using this file.
   8 --
   9 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  10 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  11 --
  12 -- The Original Code and all software distributed under the License is
  13 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  14 -- Initial Developer hereby disclaims all such warranties, including without
  15 -- limitation, any warranties of merchantability, fitness for a particular
  16 -- purpose or non-infringement. Please see the License for the specific terms
  17 -- and conditions governing the rights and limitations under the License.
  18
  19 class Pave from BOPDS
  20
  21         ---Purpose:
  22         -- The class BOPDS_Pave is to store
  23         -- information about vertex on an edge
  24 --uses
  25 --raises
  26
  27 is
  28     Create
  29         returns Pave from BOPDS;
  30     ---C++: alias "Standard_EXPORT virtual ~BOPDS_Pave();"
  31     ---C++: inline
  32         ---Purpose:
  33         --- Empty contructor
  34         ---
  35
  36     SetIndex(me:out;
  37             theIndex: Integer from Standard);
  38     ---C++: inline
  39         ---Purpose:
  40         --- Modifier
  41         --- Sets the index of vertex <theIndex>
  42
  43     Index(me)
  44         returns Integer from Standard;
  45     ---C++: inline
  46         ---Purpose:
  47         --- Selector
  48         --- Returns the index of vertex
  49     SetParameter(me:out;
  50             theParameter: Real from Standard);
  51     ---C++: inline
  52         ---Purpose:
  53         --- Modifier
  54         --- Sets the parameter of vertex <theParameter>
  55
  56     Parameter(me)
  57         returns Real from Standard;
  58     ---C++: inline
  59         ---Purpose:
  60         --- Selector
  61         --- Returns the parameter of vertex
  62     Contents(me;
  63             theIndex:out Integer from Standard;
  64             theParameter:out Real from Standard);
  65     ---C++: inline
  66         ---Purpose:
  67         --- Selector
  68         --- Returns the index of vertex <theIndex>
  69         --- Returns the parameter of vertex <theParameter>
  70
  71     IsLess(me;
  72             theOther:  Pave from BOPDS)
  73         returns Boolean from Standard;
  74     ---C++: alias operator <
  75     ---C++: inline
  76         ---Purpose:
  77         --- Query
  78         --- Returns true if thr parameter od this is less
  79         --  than the parameter of  <theOther>
  80
  81     IsEqual(me;
  82             theOther:  Pave from BOPDS)
  83         returns Boolean from Standard;
  84     ---C++: alias operator ==
  85     ---C++: inline
  86         ---Purpose:
  87         --- Query
  88         --- Returns true if thr parameter od this is equal
  89         --  to the parameter of  <theOther>
  90
  91     Dump(me);
  92
  93 fields
  94     myIndex    : Integer from Standard is protected;
  95     myParameter: Real from Standard is protected;
  96
  97 end Pave;