src/XCAFDoc/XCAFDoc_Volume.cdl

   1 -- Created on: 2000-09-08
   2 -- Created by: data exchange team
   3 -- Copyright (c) 2000-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class Volume from XCAFDoc inherits Attribute from TDF
  23
  24         ---Purpose:
  25
  26 uses
  27      Attribute       from TDF,
  28      Label           from TDF,
  29      GUID            from Standard,
  30      Real            from Standard,
  31      RelocationTable from TDF
  32
  33 is
  34     Create returns Volume from XCAFDoc;
  35
  36     ---Purpose: class methods
  37     --          =============
  38
  39     GetID (myclass)
  40         ---C++: return const &
  41     returns GUID from Standard;
  42
  43     ID (me)
  44         ---C++: return const &
  45     returns GUID from Standard;
  46
  47     Set (me: mutable; vol: Real from Standard);
  48         ---Purpose: Sets a value of volume
  49
  50     Set (myclass ; label : Label from TDF; vol: Real from Standard)
  51     returns Volume from XCAFDoc;
  52         ---Purpose: Find, or create, an Volume attribute and set its value
  53
  54     Get (me)
  55     returns Real from Standard;
  56
  57     Get (myclass ; label : Label from TDF; vol: in out Real from Standard)
  58     returns Boolean from Standard;
  59         ---Purpose: Returns volume as argument
  60         --          returns false if no such attribute at the <label>
  61
  62     Restore (me: mutable; With : Attribute from TDF);
  63
  64     NewEmpty(me)
  65     returns mutable Attribute from TDF;
  66
  67     Paste (me; Into : mutable Attribute from TDF;
  68                RT   : mutable RelocationTable from TDF);
  69
  70     Dump(me; anOS : in out OStream from Standard)
  71     returns OStream from Standard
  72     is redefined;
  73     ---C++: return &
  74
  75 fields
  76
  77     myValue     : Real     from Standard;
  78
  79 end Volume from XCAFDoc;