src/TDocStd/TDocStd_Owner.hxx

   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 #ifndef _TDocStd_Owner_HeaderFile
  18 #define _TDocStd_Owner_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <TDF_Attribute.hxx>
  24 #include <Standard_OStream.hxx>
  25 class TDocStd_Document;
  26 class Standard_GUID;
  27 class TDF_Data;
  28 class TDF_Attribute;
  29 class TDF_RelocationTable;
  30
  31
  32 class TDocStd_Owner;
  33 DEFINE_STANDARD_HANDLE(TDocStd_Owner, TDF_Attribute)
  34
  35 //! This  attribute located  at  the  root label  of the
  36 //! framework contains  a   back reference to   the  owner
  37 //! TDocStd_Document, providing acces to the document from
  38 //! any label.  private class Owner;
  39 class TDocStd_Owner : public TDF_Attribute
  40 {
  41
  42 public:
  43
  44
  45   //! class methods
  46   //! =============
  47   Standard_EXPORT static const Standard_GUID& GetID();
  48
  49   Standard_EXPORT static void SetDocument (const Handle(TDF_Data)& indata, const Handle(TDocStd_Document)& doc);
  50
  51   Standard_EXPORT static void SetDocument (const Handle(TDF_Data)& indata, TDocStd_Document* doc);
  52
  53   //! Owner methods
  54   //! ===============
  55   Standard_EXPORT static Handle(TDocStd_Document) GetDocument (const Handle(TDF_Data)& ofdata);
  56
  57   Standard_EXPORT TDocStd_Owner();
  58
  59   Standard_EXPORT void SetDocument (const Handle(TDocStd_Document)& document);
  60
  61   Standard_EXPORT void SetDocument (TDocStd_Document* document);
  62
  63   Standard_EXPORT Handle(TDocStd_Document) GetDocument() const;
  64
  65   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  66
  67   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  68
  69   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  70
  71   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  72
  73   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  74
  75   //! Dumps the content of me into the stream
  76   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
  77
  78
  79
  80
  81   DEFINE_STANDARD_RTTIEXT(TDocStd_Owner,TDF_Attribute)
  82
  83 protected:
  84
  85
  86
  87
  88 private:
  89
  90   //! It keeps pointer to the document to avoid handles cyclic dependency
  91   TDocStd_Document* myDocument;
  92
  93
  94 };
  95
  96
  97
  98
  99
 100
 101
 102 #endif // _TDocStd_Owner_HeaderFile