src/XCAFDoc/XCAFDoc_Location.cdl

   1 -- Created on: 2000-08-15
   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 Location from XCAFDoc inherits Attribute from TDF
  23
  24         ---Purpose:
  25
  26 uses
  27     Location from TopLoc,
  28     Label from TDF,
  29     RelocationTable from TDF
  30
  31 is
  32     Create returns Location from XCAFDoc;
  33
  34     ---Purpose: class methods
  35     --          =============
  36
  37     GetID (myclass)
  38         ---C++: return const &
  39     returns GUID from Standard;
  40
  41     Set (myclass; label : Label from TDF; Loc : Location from TopLoc)
  42     ---Purpose: Find, or create, a Location attribute and set it's value
  43     --          the Location attribute is returned.
  44     returns Location from XCAFDoc;
  45
  46     ---Purpose: Location methods
  47     --          ===============
  48
  49     Set (me : mutable; Loc : Location from TopLoc);
  50
  51     Get (me)
  52     returns Location from TopLoc;
  53
  54     --IsCaptured(me) returns Boolean;
  55         ---Purpose: Returns True if there is a reference on the same label
  56
  57     ---Category: methodes de TDF_Attribute
  58     --           =========================
  59
  60     ID (me)
  61         ---C++: return const &
  62     returns GUID from Standard;
  63
  64     Restore (me: mutable; With : Attribute from TDF);
  65
  66     NewEmpty (me)
  67     returns mutable Attribute from TDF;
  68
  69     Paste (me; Into : mutable Attribute from TDF;
  70                RT   : mutable RelocationTable from TDF);
  71
  72 --    Dump(me; anOS : in out OStream from Standard)
  73 --      returns OStream from Standard
  74 --      is redefined;
  75 --      -C++: return &
  76
  77 fields
  78     myLocation : Location from TopLoc;
  79
  80 end Location;