src/XCAFDoc/XCAFDoc_Area.cdl

   1 -- Created on: 2000-09-08
   2 -- Created by: data exchange team
   3 -- Copyright (c) 2000-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class Area from XCAFDoc inherits Attribute from TDF
  17
  18         ---Purpose: attribute to store area
  19
  20 uses
  21      Attribute       from TDF,
  22      Label           from TDF,
  23      GUID            from Standard,
  24      Real            from Standard,
  25      RelocationTable from TDF
  26
  27 is
  28     Create returns Area from XCAFDoc;
  29
  30     ---Purpose: class methods
  31     --          =============
  32
  33     GetID (myclass)
  34         ---C++: return const &
  35     returns GUID from Standard;
  36
  37     ID (me)
  38         ---C++: return const &
  39     returns GUID from Standard;
  40
  41     Set (me: mutable; vol: Real from Standard);
  42         ---Purpose: Sets a value of volume
  43
  44     Set (myclass ; label : Label from TDF; area: Real from Standard)
  45     returns Area from XCAFDoc;
  46         ---Purpose: Find, or create, an Area attribute and set its value
  47
  48     Get (me)
  49     returns Real from Standard;
  50
  51     Get (myclass ; label : Label from TDF; area: in out Real from Standard)
  52     returns Boolean from Standard;
  53         ---Purpose: Returns volume of area as argument and succes status
  54         --          returns false if no such attribute at the <label>
  55
  56     Restore (me: mutable; With : Attribute from TDF);
  57
  58     NewEmpty(me)
  59     returns Attribute from TDF;
  60
  61     Paste (me; Into : Attribute from TDF;
  62                RT   : RelocationTable from TDF);
  63
  64     Dump(me; anOS : in out OStream from Standard)
  65     returns OStream from Standard
  66     is redefined;
  67     ---C++: return &
  68
  69 fields
  70
  71     myValue     : Real     from Standard;
  72
  73 end Area from XCAFDoc;