src/TDataStd/TDataStd_Directory.cdl

   1 -- Created on: 1999-06-25
   2 -- Created by: Sergey RUIN
   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 Directory from TDataStd inherits Attribute from TDF
  18
  19         ---Purpose: Associates a directory in the data framework with
  20         -- a TDataStd_TagSource attribute.
  21         -- You can create a new directory label and add
  22         -- sub-directory or object labels to it,
  23
  24
  25 uses Attribute       from TDF,
  26      Label           from TDF,
  27      GUID            from Standard,
  28      DataSet         from TDF,
  29      RelocationTable from TDF
  30 is
  31
  32
  33     ---Purpose: class methods
  34     --          =============
  35
  36
  37     Find (myclass; current : Label from TDF; D : in out Directory from TDataStd)
  38         ---Purpose: Searches for a directory attribute on the label
  39         -- current, or on one of the father labels of current.
  40         -- If a directory attribute is found, true is returned,
  41         -- and the attribute found is set as D.
  42     returns Boolean from Standard;
  43
  44     New (myclass; label : Label from TDF)
  45         ---Purpose:  Creates  an  enpty   Directory attribute,  located  at
  46         --          <label>. Raises if <label> has attribute
  47     returns Directory from TDataStd;
  48
  49     AddDirectory (myclass; dir : Directory from TDataStd)
  50         ---Purpose:  Creates a new sub-label and sets the
  51         -- sub-directory dir on that label.
  52     returns Directory from TDataStd;
  53
  54     MakeObjectLabel (myclass; dir : Directory from TDataStd)
  55         ---Purpose:  Makes new label and returns it to insert
  56         --           other object attributes (sketch,part...etc...)
  57     returns Label from TDF;
  58
  59
  60     GetID (myclass)
  61         ---C++: return const &
  62     returns GUID from Standard;
  63
  64
  65     ---Purpose: Directory methods
  66     --          ===============
  67
  68     Create
  69     returns mutable Directory from TDataStd;
  70
  71     ---Category: methodes de TDF_Attribute
  72     --           =========================
  73
  74     ID (me)
  75     ---C++: return const &
  76     returns GUID from Standard;
  77
  78     Restore (me: mutable; with : Attribute from TDF);
  79
  80     NewEmpty (me)
  81     returns mutable Attribute from TDF;
  82
  83     Paste (me; into : mutable Attribute from TDF;
  84                RT   : mutable RelocationTable from TDF);
  85
  86     References (me; DS : DataSet from TDF) is redefined;
  87
  88     Dump(me; anOS : in out OStream from Standard)
  89     returns OStream from Standard
  90      is redefined;
  91         ---C++: return &
  92
  93 end Directory;