1 // Created on: 1997-10-22
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _CDM_Reference_HeaderFile
18 #define _CDM_Reference_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <CDM_DocumentPointer.hxx>
24 #include <Standard_Integer.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Transient.hxx>
28 class CDM_Application;
33 DEFINE_STANDARD_HANDLE(CDM_Reference, Standard_Transient)
36 class CDM_Reference : public Standard_Transient
42 Standard_EXPORT Handle(CDM_Document) FromDocument();
44 Standard_EXPORT Handle(CDM_Document) ToDocument();
46 Standard_EXPORT Standard_Integer ReferenceIdentifier();
48 Standard_EXPORT Standard_Integer DocumentVersion() const;
50 Standard_EXPORT Standard_Boolean IsReadOnly() const;
52 //! Dumps the content of me into the stream
53 Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
56 friend class CDM_Document;
59 DEFINE_STANDARD_RTTIEXT(CDM_Reference,Standard_Transient)
69 Standard_EXPORT CDM_Reference(const Handle(CDM_Document)& aFromDocument, const Handle(CDM_Document)& aToDocument, const Standard_Integer aReferenceIdentifier, const Standard_Integer aToDocumentVersion);
71 Standard_EXPORT CDM_Reference(const Handle(CDM_Document)& aFromDocument, const Handle(CDM_MetaData)& aMetaData, const Standard_Integer aReferenceIdentifier, const Handle(CDM_Application)& anApplication, const Standard_Integer aToDocumentVersion, const Standard_Boolean UseStorageConfiguration);
73 Standard_EXPORT void Update (const Handle(CDM_MetaData)& aMetaData);
75 //! compares the actual document version with the
76 //! document version at the creation of the reference
77 Standard_EXPORT Standard_Boolean IsUpToDate() const;
79 Standard_EXPORT void SetIsUpToDate();
81 Standard_EXPORT void UnsetToDocument (const Handle(CDM_MetaData)& aMetaData, const Handle(CDM_Application)& anApplication);
83 //! returns true if the ToDocument has been retrieved
85 Standard_EXPORT Standard_Boolean IsOpened() const;
87 Standard_EXPORT Handle(CDM_Document) Document() const;
89 Standard_EXPORT Handle(CDM_MetaData) MetaData() const;
91 Standard_EXPORT Handle(CDM_Application) Application() const;
93 Standard_EXPORT Standard_Boolean UseStorageConfiguration() const;
95 Standard_EXPORT Standard_Boolean IsInSession() const;
97 Standard_EXPORT Standard_Boolean IsStored() const;
99 Handle(CDM_Document) myToDocument;
100 CDM_DocumentPointer myFromDocument;
101 Standard_Integer myReferenceIdentifier;
102 Handle(CDM_Application) myApplication;
103 Handle(CDM_MetaData) myMetaData;
104 Standard_Integer myDocumentVersion;
105 Standard_Boolean myUseStorageConfiguration;
116 #endif // _CDM_Reference_HeaderFile