src/Dynamic/Dynamic_BooleanParameter.cdl

   1 -- Created on: 1994-01-24
   2 -- Created by: Gilles DEBARBOUILLE
   3 -- Copyright (c) 1994-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 BooleanParameter from Dynamic
  18
  19 inherits
  20     Parameter from Dynamic
  21
  22         ---Purpose: This class describes a parameter with a boolean
  23         --          as value.
  24
  25 uses
  26
  27    CString from Standard,
  28    OStream from Standard
  29
  30 is
  31
  32     Create(aparameter : CString from Standard)
  33
  34     ---Level: Advanced
  35
  36     ---Purpose: Creates a boolean parameter with <aparameter> as name.
  37
  38     returns mutable BooleanParameter from Dynamic;
  39
  40     Create(aparameter : CString from Standard;
  41            avalue : Boolean from Standard)
  42
  43     ---Level: Advanced
  44
  45     ---Purpose: Creates a boolean parameter with <aparameter> and <avalue>
  46     --          respectively as name and value.
  47
  48     returns mutable BooleanParameter from Dynamic;
  49
  50     Create(aparameter , avalue : CString from Standard)
  51
  52     ---Level: Advanced
  53
  54     ---Purpose: Creates a boolean parameter with <aparameter> as name
  55     --          and <avalue> as value. <avalue> is a CString with two possible
  56     --          values which are : "Standard_True" and "Standard_False".
  57
  58     returns mutable BooleanParameter from Dynamic;
  59
  60     Value(me) returns Boolean from Standard
  61
  62     ---Level: Public
  63
  64     ---Purpose: Returns the boolean value <thevalue>.
  65
  66     is static;
  67
  68     Value (me : mutable ; avalue : Boolean from Standard)
  69
  70     ---Level: Advanced
  71
  72     --- Purpose: Sets the field <thevalue> with the boolean value <avalue>
  73
  74     is static;
  75
  76     Dump(me ; astream : in out OStream from Standard)
  77
  78     ---Level: Internal
  79
  80     ---Purpose: Useful for debugging.
  81
  82     is redefined;
  83
  84 fields
  85
  86     thevalue : Boolean from Standard;
  87
  88 end BooleanParameter;