src/TDataStd/TDataStd_Directory.hxx

   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 #ifndef _TDataStd_Directory_HeaderFile
  18 #define _TDataStd_Directory_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <TDF_Attribute.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_OStream.hxx>
  26 class TDF_Label;
  27 class Standard_GUID;
  28 class TDF_Attribute;
  29 class TDF_RelocationTable;
  30 class TDF_DataSet;
  31
  32
  33 class TDataStd_Directory;
  34 DEFINE_STANDARD_HANDLE(TDataStd_Directory, TDF_Attribute)
  35
  36 //! Associates a directory in the data framework with
  37 //! a TDataStd_TagSource attribute.
  38 //! You can create a new directory label and add
  39 //! sub-directory or object labels to it,
  40 class TDataStd_Directory : public TDF_Attribute
  41 {
  42
  43 public:
  44
  45
  46   //! class methods
  47   //! =============
  48   //! Searches for a directory attribute on the label
  49   //! current, or on one of the father labels of current.
  50   //! If a directory attribute is found, true is returned,
  51   //! and the attribute found is set as D.
  52   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& current, Handle(TDataStd_Directory)& D);
  53
  54   //! Creates  an  enpty   Directory attribute,  located  at
  55   //! <label>. Raises if <label> has attribute
  56   Standard_EXPORT static Handle(TDataStd_Directory) New (const TDF_Label& label);
  57
  58   //! Creates a new sub-label and sets the
  59   //! sub-directory dir on that label.
  60   Standard_EXPORT static Handle(TDataStd_Directory) AddDirectory (const Handle(TDataStd_Directory)& dir);
  61
  62   //! Makes new label and returns it to insert
  63   //! other object attributes (sketch,part...etc...)
  64   Standard_EXPORT static TDF_Label MakeObjectLabel (const Handle(TDataStd_Directory)& dir);
  65
  66   //! Directory methods
  67   //! ===============
  68   Standard_EXPORT static const Standard_GUID& GetID();
  69
  70   Standard_EXPORT TDataStd_Directory();
  71
  72   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  73
  74   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
  75
  76   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  77
  78   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  79
  80   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
  81
  82   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  83
  84   //! Dumps the content of me into the stream
  85   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
  86
  87
  88
  89
  90   DEFINE_STANDARD_RTTIEXT(TDataStd_Directory,TDF_Attribute)
  91
  92 protected:
  93
  94
  95
  96
  97 private:
  98
  99
 100
 101
 102 };
 103
 104
 105
 106
 107
 108
 109
 110 #endif // _TDataStd_Directory_HeaderFile