src/Dynamic/Dynamic_DynamicInstance.cdl

   1 -- Created on: 1993-01-22
   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 DynamicInstance from Dynamic
  18
  19 inherits
  20
  21     TShared from MMgt
  22         ---Purpose: A dynamic  instance is a reference  to the dynamic
  23         --          class and a  sequence of  parameters which  is the
  24         --          complete listing of all the parameters  of all the
  25         --          inherited classes.
  26
  27
  28 uses
  29
  30     CString from Standard,
  31     Integer from Standard,
  32     Real    from Standard,
  33     DynamicClass  from Dynamic,
  34     Parameter     from Dynamic,
  35     ParameterNode from Dynamic
  36
  37
  38
  39 is
  40
  41     Create returns mutable DynamicInstance from Dynamic;
  42
  43     ---Level: Internal
  44
  45     ---Purpose: Creates an empty instance of this class.
  46
  47     Parameter(me : mutable ; aparameter : any Parameter from Dynamic)
  48
  49     ---Level: Internal
  50
  51     ---Purpose: Adds  <aparameter> to  the   sequence of parameters of
  52     --          <me>.
  53
  54     is static;
  55
  56     Parameter(me ; aninstance : mutable DynamicInstance from Dynamic)
  57
  58     ---Level: Internal
  59
  60     ---Purpose: Adds all the parameters  of <me>,  to the sequence  of
  61     --          parameters of <aninstance>.
  62
  63     is static;
  64
  65     Parameter(me ; aparameter : CString from Standard; avalue : Integer from Standard)
  66
  67     ---Level: Public
  68
  69     ---Purpose: Puts the integer value <avalue> into the parameter
  70     --          object identified by the string <aparameter>.
  71
  72     is static;
  73
  74     Parameter(me ; aparameter : CString from Standard ; avalue : Real from Standard)
  75
  76     ---Level: Public
  77
  78     ---Purpose: Puts the real value <avalue> into the parameter
  79     --          object identified by the string <aparameter>.
  80
  81     is static;
  82
  83     Parameter(me ; aparameter : CString from Standard; avalue : CString from Standard)
  84
  85     ---Level: Public
  86
  87     ---Purpose: Puts the string <avalue> into the parameter
  88     --          object identified by the string <aparameter>.
  89
  90     is static;
  91
  92     Parameter(me ; aparameter : CString from Standard; avalue : any DynamicInstance from Dynamic)
  93
  94     ---Level: Public
  95
  96     ---Purpose: Puts the dynamic instance <avalue> into the parameter
  97     --          object identified by the string <aparameter>.
  98
  99     is static;
 100
 101     Parameter(me ; aparameter : CString from Standard) returns any Parameter from Dynamic
 102
 103     ---Level: Public
 104
 105     ---Purpose: Searches and returns the parameter object identified
 106     --          by the string <aparameter>.
 107
 108     is static;
 109
 110     Class(me : mutable ; aclass : any DynamicClass from Dynamic)
 111
 112     ---Level: Internal
 113
 114     ---Purpose: Sets the reference of the class.
 115
 116     is static;
 117
 118     Execute(me ; amethod : CString from Standard)
 119
 120     ---Level: Public
 121
 122     ---Purpose: Calls the method identified by the string <amethod>.
 123
 124     is static;
 125
 126 fields
 127
 128     thedynamicclass       : DynamicClass  from Dynamic;
 129     thefirstparameternode : ParameterNode from Dynamic;
 130
 131 end ;