src/Dynamic/Dynamic_StringParameter.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 StringParameter from Dynamic
  18
  19 inherits
  20
  21     Parameter from Dynamic
  22
  23
  24         ---Purpose: This inherited class  from Parameter describes all
  25         --          the  parameters,  which   are  characterized by  a
  26         --          string value.
  27
  28 uses
  29
  30     OStream from Standard,
  31     CString from Standard,
  32     HAsciiString from TCollection,
  33     AsciiString  from TCollection
  34
  35 is
  36
  37     Create(aparameter : CString from Standard )
  38
  39     ---Level: Public
  40
  41     ---Purpose: Creates a StringParameter with <aparameter> as name.
  42
  43     returns mutable StringParameter from Dynamic;
  44
  45     Create(aparameter : CString from Standard ; astring : CString from Standard)
  46
  47     ---Level: Public
  48
  49     ---Purpose: With  the name of  the  Parameter <aparameter> and the
  50     --          string    <astring>,   creates    an    instance    of
  51     --          StringParameter.
  52
  53     returns mutable StringParameter from Dynamic;
  54
  55     Value(me) returns AsciiString from TCollection
  56
  57     ---Level: Public
  58
  59     ---Purpose: Returns the value    of  the parameter which     is an
  60     --          AsciiString.
  61
  62     is static;
  63
  64     Value (me : mutable ; avalue : CString from Standard)
  65
  66     ---Level: Public
  67
  68     --- Purpose: Sets the string <avalue> in <me>.
  69
  70     is static;
  71
  72     Dump(me ; astream : in out OStream from Standard)
  73
  74     ---Level: Internal
  75
  76     ---Purpose: Useful for debugging.
  77
  78     is redefined;
  79
  80 fields
  81
  82     thestring : HAsciiString from TCollection;
  83
  84 end StringParameter;