include/opencascade/TDocStd_Owner.hxx

0001 // Created on: 1999-07-12
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TDocStd_Owner_HeaderFile
0018 #define _TDocStd_Owner_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TDF_Attribute.hxx>
0024 #include <Standard_OStream.hxx>
0025 class TDocStd_Document;
0026 class Standard_GUID;
0027 class TDF_Data;
0028 class TDF_RelocationTable;
0029
0030 //! This attribute located at the root label of the
0031 //! framework contains a back reference to the owner
0032 //! TDocStd_Document, providing access to the document
0033 //! from any label. private class Owner;
0034 class TDocStd_Owner : public TDF_Attribute
0035 {
0036
0037 public:
0038   //! class methods
0039   //! =============
0040   Standard_EXPORT static const Standard_GUID& GetID();
0041
0042   Standard_EXPORT static void SetDocument(const occ::handle<TDF_Data>&         indata,
0043                                           const occ::handle<TDocStd_Document>& doc);
0044
0045   Standard_EXPORT static void SetDocument(const occ::handle<TDF_Data>& indata,
0046                                           TDocStd_Document*            doc);
0047
0048   //! Owner methods
0049   //! ===============
0050   Standard_EXPORT static occ::handle<TDocStd_Document> GetDocument(
0051     const occ::handle<TDF_Data>& ofdata);
0052
0053   Standard_EXPORT TDocStd_Owner();
0054
0055   Standard_EXPORT void SetDocument(const occ::handle<TDocStd_Document>& document);
0056
0057   Standard_EXPORT void SetDocument(TDocStd_Document* document);
0058
0059   Standard_EXPORT occ::handle<TDocStd_Document> GetDocument() const;
0060
0061   Standard_EXPORT const Standard_GUID& ID() const override;
0062
0063   Standard_EXPORT void Restore(const occ::handle<TDF_Attribute>& With) override;
0064
0065   Standard_EXPORT occ::handle<TDF_Attribute> NewEmpty() const override;
0066
0067   Standard_EXPORT void Paste(const occ::handle<TDF_Attribute>&       Into,
0068                              const occ::handle<TDF_RelocationTable>& RT) const override;
0069
0070   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0071
0072   //! Dumps the content of me into the stream
0073   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0074
0075   DEFINE_STANDARD_RTTIEXT(TDocStd_Owner, TDF_Attribute)
0076
0077 private:
0078   //! It keeps pointer to the document to avoid handles cyclic dependency
0079   TDocStd_Document* myDocument;
0080 };
0081
0082 #endif // _TDocStd_Owner_HeaderFile