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
0031 class TDocStd_Owner;
0032 DEFINE_STANDARD_HANDLE(TDocStd_Owner, TDF_Attribute)
0033
0034 //! This  attribute located  at  the  root label  of the
0035 //! framework contains  a   back reference to   the  owner
0036 //! TDocStd_Document, providing access to the document from
0037 //! any label.  private class Owner;
0038 class TDocStd_Owner : public TDF_Attribute
0039 {
0040
0041 public:
0042
0043
0044   //! class methods
0045   //! =============
0046   Standard_EXPORT static const Standard_GUID& GetID();
0047
0048   Standard_EXPORT static void SetDocument (const Handle(TDF_Data)& indata, const Handle(TDocStd_Document)& doc);
0049
0050   Standard_EXPORT static void SetDocument (const Handle(TDF_Data)& indata, TDocStd_Document* doc);
0051
0052   //! Owner methods
0053   //! ===============
0054   Standard_EXPORT static Handle(TDocStd_Document) GetDocument (const Handle(TDF_Data)& ofdata);
0055
0056   Standard_EXPORT TDocStd_Owner();
0057
0058   Standard_EXPORT void SetDocument (const Handle(TDocStd_Document)& document);
0059
0060   Standard_EXPORT void SetDocument (TDocStd_Document* document);
0061
0062   Standard_EXPORT Handle(TDocStd_Document) GetDocument() const;
0063
0064   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0065
0066   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0067
0068   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0069
0070   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0071
0072   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0073
0074   //! Dumps the content of me into the stream
0075   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0076
0077
0078
0079
0080   DEFINE_STANDARD_RTTIEXT(TDocStd_Owner,TDF_Attribute)
0081
0082 protected:
0083
0084
0085
0086
0087 private:
0088
0089   //! It keeps pointer to the document to avoid handles cyclic dependency
0090   TDocStd_Document* myDocument;
0091
0092
0093 };
0094
0095
0096
0097
0098
0099
0100
0101 #endif // _TDocStd_Owner_HeaderFile