src/Dynamic/Dynamic_IntegerParameter.cdl

   1 -- Created on: 1993-02-03
   2 -- Created by: Gilles DEBARBOUILLE
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class IntegerParameter from Dynamic
  18
  19 inherits
  20
  21     Parameter from Dynamic
  22
  23         ---Purpose: This class describes a parameter with an integer
  24         --          as its value.
  25
  26 uses
  27     CString from Standard,
  28     Integer from Standard,
  29     OStream from Standard
  30
  31 is
  32
  33     Create(aparameter : CString from Standard)
  34
  35     ---Level: Public
  36
  37     ---Purpose: Creates   an  IntegerParameter  with  <aparameter>  as
  38     --          identifier.
  39
  40     returns mutable IntegerParameter from Dynamic;
  41
  42     Create(aparameter : CString from Standard ; avalue : Integer from Standard)
  43
  44     ---Level: Public
  45
  46     ---Purpose: Creates   an  IntegerParameter  with  <aparameter>  as
  47     --          identifier and <avalue> as initial value.
  48
  49     returns mutable IntegerParameter from Dynamic;
  50
  51     Value(me) returns Integer from Standard
  52
  53     ---Level: Public
  54
  55     ---Purpose: Returns the integer value <thevalue>.
  56
  57     is static;
  58
  59     Value (me : mutable ; avalue : Integer from Standard)
  60
  61     ---Level: Public
  62
  63     --- Purpose: Sets the field <thevalue> with the integer value <avalue>
  64
  65     is static;
  66
  67     Dump(me ; astream : in out OStream from Standard)
  68
  69     ---Level: Public
  70
  71     ---Purpose: Useful for debugging.
  72
  73     is redefined;
  74
  75 fields
  76
  77     thevalue : Integer from Standard;
  78
  79 end IntegerParameter;