src/TDataStd/TDataStd_Expression.cdl

   1 -- Created on: 1997-12-16
   2 -- Created by: Denis PASCAL
   3 -- Copyright (c) 1997-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 Expression from TDataStd inherits Attribute from TDF
  18
  19     ---Purpose: Expression attribute.
  20     --          ====================
  21     --
  22     --            * Data Structure  of the Expression   is stored in a
  23     --           string and references to variables used by the string
  24     --
  25     --  Warning:  To be consistent,  each  Variable  referenced by  the
  26     --          expression must have its equivalent in the string
  27
  28
  29 uses Attribute         from TDF,
  30      Label             from TDF,
  31      GUID              from Standard,
  32      Real              from Standard,
  33      DataSet           from TDF,
  34      RelocationTable   from TDF,
  35      ExtendedString    from TCollection,
  36      AttributeList     from TDF
  37
  38
  39 is
  40
  41     ---Purpose: class methods
  42     --          =============
  43
  44     GetID (myclass)
  45         ---C++: return const &
  46     returns GUID from Standard;
  47
  48
  49     Set (myclass ; label : Label from TDF)
  50     ---Purpose: Find, or create, an Expression attribute.
  51     returns Expression from TDataStd;
  52
  53     ---Purpose: Expressionmethods
  54     --          ============
  55
  56     Create
  57     returns mutable Expression from TDataStd;
  58
  59     Name (me)
  60     ---Purpose: build and return the expression name
  61     returns ExtendedString from TCollection;
  62
  63     SetExpression (me : mutable; E : ExtendedString from TCollection);
  64
  65     GetExpression (me)
  66     returns ExtendedString from TCollection;
  67     ---C++: return const &
  68
  69     GetVariables (me : mutable)
  70     ---C++: return &
  71     returns AttributeList from TDF;
  72
  73     ---Category: TDF_Attribute methods
  74     --           =====================
  75
  76     ID (me)
  77     ---C++: return const &
  78     returns GUID from Standard;
  79
  80     Restore (me: mutable; With : Attribute from TDF);
  81
  82     NewEmpty(me)
  83     returns mutable Attribute from TDF;
  84
  85     Paste (me; Into : mutable Attribute from TDF;
  86                RT   : mutable RelocationTable from TDF);
  87
  88     Dump(me; anOS : in out OStream from Standard)
  89     returns OStream from Standard
  90     is redefined;
  91     ---C++: return &
  92
  93 fields
  94
  95     myExpression : ExtendedString from TCollection;
  96     myVariables  : AttributeList from TDF;
  97
  98 end Expression;