src/BOPTools/BOPTools_CoupleOfInteger.cdl

   1 -- Created on: 2002-04-01
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2002-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 CoupleOfInteger from BOPTools
  23
  24         ---Purpose:
  25         --  Auxiliary class providing structure to
  26         --  store info about a couple of integers
  27
  28 --uses
  29 --raises
  30
  31 is
  32     Create
  33         returns CoupleOfInteger from BOPTools;
  34         ---Purpose:
  35         --- Empty Constructor
  36         ---
  37     Create(aFirst  : Integer from Standard;
  38            aSecond : Integer from Standard)
  39         returns CoupleOfInteger from BOPTools;
  40         ---Purpose:
  41         --- Constructor
  42         ---
  43     SetCouple(me:out;
  44            aFirst  : Integer from Standard;
  45            aSecond : Integer from Standard);
  46         ---Purpose:
  47         --- Modifier
  48         ---
  49     SetFirst(me:out;
  50            aFirst  : Integer from Standard);
  51         ---Purpose:
  52         --- Modifier
  53         ---
  54     SetSecond(me:out;
  55            aSecond : Integer from Standard);
  56         ---Purpose:
  57         --- Modifier
  58         ---
  59     Couple   (me;
  60            aFirst  :out Integer from Standard;
  61            aSecond :out Integer from Standard);
  62         ---Purpose:
  63         --- Selector
  64         ---
  65     First(me)
  66         returns Integer from Standard;
  67         ---Purpose:
  68         --- Selector
  69         ---
  70     Second(me)
  71         returns Integer from Standard;
  72         ---Purpose:
  73         --- Selector
  74         ---
  75
  76     IsEqual(me;
  77             aOther:like me)
  78         returns Boolean from Standard;
  79
  80     HashCode(me;
  81             Upper : Integer  from Standard)
  82         returns Integer from Standard;
  83
  84 fields
  85     myFirst  : Integer from Standard;
  86     mySecond : Integer from Standard;
  87
  88 end CoupleOfInteger;