src/TDataStd/TDataStd_Current.cdl

   1 -- Created on: 1999-08-02
   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 class Current from TDataStd inherits Attribute from TDF
  18
  19         ---Purpose: this attribute,  located at root label,  manage an
  20         --          access to a current label.
  21
  22 uses Attribute       from TDF,
  23      Label           from TDF,
  24      GUID            from Standard,
  25      DataSet         from TDF,
  26      RelocationTable from TDF
  27
  28 is
  29
  30     ---Purpose: class methods
  31     --          =============
  32
  33
  34     GetID (myclass)
  35         ---C++: return const &
  36     returns GUID from Standard;
  37
  38
  39     Set (myclass; L : Label from TDF);
  40     ---Purpose: Set <L> as current of <L> Framework.
  41
  42
  43     Get (myclass; acces : Label from TDF)
  44     ---Purpose: returns current of <acces> Framework. raise if (!Has)
  45     returns Label from TDF;
  46
  47
  48     Has (myclass; acces : Label from TDF)
  49     ---Purpose: returns True if a  current label is managed in <acces>
  50     --          Framework.
  51     returns Boolean from Standard;
  52
  53     ---Purpose: class methods
  54     --          =============
  55
  56     Create
  57     returns Current from TDataStd;
  58
  59     SetLabel (me : mutable; current : Label from TDF);
  60
  61     GetLabel (me)
  62     returns Label from TDF;
  63
  64         ---Category: TDF_Attribute methods
  65         --           =====================
  66
  67     ID (me)
  68         ---C++: return const &
  69     returns GUID from Standard;
  70
  71     Restore (me: mutable; With : Attribute from TDF);
  72
  73     NewEmpty (me)
  74     returns Attribute from TDF;
  75
  76     Paste (me; Into : Attribute from TDF;
  77                RT   : RelocationTable from TDF);
  78
  79     Dump(me; anOS : in out OStream from Standard)
  80     returns OStream from Standard
  81     is redefined;
  82     ---C++: return &
  83
  84
  85 fields
  86
  87     myLabel : Label from TDF;
  88
  89 end Current;