src/TDocStd/TDocStd_Modified.cdl

   1 -- Created on: 1999-07-12
   2 -- Created by: Denis PASCAL
   3 -- Copyright (c) 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 private class Modified from TDocStd inherits Attribute from TDF
  18
  19     ---Purpose:   Transient     attribute   wich     register modified
  20     --          labels. This attribute is attached to root label.
  21
  22
  23 uses Label           from TDF,
  24      Attribute       from TDF,
  25      LabelMap        from TDF,
  26      RelocationTable from TDF
  27
  28
  29 is
  30
  31     ---Purpose: API class methods
  32     --          =================
  33
  34     IsEmpty (myclass; access : Label from TDF)
  35     returns Boolean;
  36
  37     Add (myclass; alabel : Label from TDF)
  38     returns Boolean;
  39
  40     Remove (myclass; alabel : Label from TDF)
  41     returns Boolean;
  42
  43     Contains (myclass; alabel : Label from TDF)
  44     returns Boolean;
  45
  46     Get (myclass; access : Label from TDF)
  47     ---Purpose: if <IsEmpty> raise an exception.
  48     ---C++: return const &
  49     returns LabelMap from TDF;
  50
  51     Clear (myclass; access : Label from TDF);
  52     ---Purpose: remove all modified labels. becomes empty
  53
  54     GetID (myclass)
  55     ---C++: return const &
  56     returns GUID from Standard;
  57
  58     ---Purpose: Modified methods
  59     --          ================
  60
  61     Create
  62     returns Modified from TDocStd;
  63
  64     IsEmpty (me)
  65     returns Boolean from Standard;
  66
  67     Clear (me : mutable);
  68
  69     AddLabel (me : mutable; L : Label from TDF)
  70     ---Purpose: add <L> as modified
  71     returns Boolean from Standard;
  72
  73     RemoveLabel (me : mutable; L : Label from TDF)
  74     ---Purpose: remove  <L> as modified
  75     returns Boolean from Standard;
  76
  77     Get (me)
  78     ---Purpose: returns modified label map
  79     ---C++: return const &
  80     returns LabelMap from TDF;
  81
  82     ---Category: methodes de TDF_Attribute
  83     --           =========================
  84
  85     ID (me)
  86     ---C++: return const &
  87     returns GUID from Standard;
  88
  89     Restore (me: mutable; With : Attribute from TDF);
  90
  91     NewEmpty (me)
  92     returns Attribute from TDF;
  93
  94     Paste (me; Into : Attribute from TDF;
  95                RT   : RelocationTable from TDF);
  96
  97     Dump (me; anOS : in out OStream from Standard)
  98     returns OStream from Standard
  99     is redefined;
 100     ---C++: return &
 101
 102 fields
 103
 104     myModified : LabelMap from TDF;
 105
 106 end Modified;