src/TDataStd/TDataStd_Real.cdl

   1 -- Created on: 1997-02-06
   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 Real from TDataStd inherits Attribute  from TDF
  18
  19     ---Purpose: The basis to define a real number attribute.
  20
  21 uses Attribute       from TDF,
  22      Label           from TDF,
  23      GUID            from Standard,
  24      Real            from Standard,
  25      RelocationTable from TDF,
  26      RealEnum        from TDataStd
  27
  28 is
  29
  30     ---Purpose: class methods
  31     --          =============
  32
  33     GetID (myclass)
  34         ---C++: return const &
  35         ---Purpose:  Returns the GUID for real numbers.
  36     returns GUID from Standard;
  37
  38     Set (myclass ; label : Label from TDF; value : Real from Standard)
  39     ---Purpose: Finds, or creates, an Real attribute and sets <value> the
  40     --          Real attribute  is  returned. the  Real  dimension is
  41     --          Scalar by default. use SetDimension to overwrite.
  42     returns Real from TDataStd;
  43
  44     ---Purpose: Real methods
  45     --          ============
  46
  47     Create
  48     returns Real from TDataStd;
  49
  50     SetDimension (me : mutable; DIM : RealEnum from TDataStd);
  51
  52
  53     GetDimension (me)
  54     returns RealEnum from TDataStd;
  55
  56
  57     Set (me : mutable; V : Real from Standard);
  58         ---Purpose:
  59         -- Finds or creates the real number V.
  60
  61     Get (me)
  62     returns Real from Standard;
  63         ---Purpose:
  64         -- Returns the real number value contained in the attribute.
  65     IsCaptured(me) returns Boolean;
  66         ---Purpose: Returns True if there is a reference on the same label
  67
  68     ---Category: TDF_Attribute methods
  69     --           =====================
  70
  71     ID (me)
  72     ---C++: return const &
  73     returns GUID from Standard;
  74
  75     Restore (me: mutable; With : Attribute from TDF);
  76
  77     NewEmpty(me)
  78     returns Attribute from TDF;
  79
  80     Paste (me; Into : Attribute from TDF;
  81                RT   : RelocationTable from TDF);
  82
  83
  84     Dump(me; anOS : in out OStream from Standard)
  85     returns OStream from Standard
  86     is redefined;
  87     ---C++: return &
  88
  89 fields
  90
  91     myValue     : Real     from Standard;
  92     myDimension : RealEnum from TDataStd;
  93
  94 end Real;