summaryrefslogtreecommitdiff
path: root/inc/CDM_Reference.hxx
blob: be0b0f74610832881bd9f0598e6aca1518e6d3fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _CDM_Reference_HeaderFile
#define _CDM_Reference_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_CDM_Reference_HeaderFile
#include <Handle_CDM_Reference.hxx>
#endif

#ifndef _Handle_CDM_Document_HeaderFile
#include <Handle_CDM_Document.hxx>
#endif
#ifndef _CDM_DocumentPointer_HeaderFile
#include <CDM_DocumentPointer.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_CDM_Application_HeaderFile
#include <Handle_CDM_Application.hxx>
#endif
#ifndef _Handle_CDM_MetaData_HeaderFile
#include <Handle_CDM_MetaData.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Transient_HeaderFile
#include <Standard_Transient.hxx>
#endif
class CDM_Document;
class CDM_Application;
class CDM_MetaData;



class CDM_Reference : public Standard_Transient {

public:

  
  Standard_EXPORT     Handle_CDM_Document FromDocument() ;
  
  Standard_EXPORT     Handle_CDM_Document ToDocument() ;
  
  Standard_EXPORT     Standard_Integer ReferenceIdentifier() ;
  
  Standard_EXPORT     Standard_Integer DocumentVersion() const;
  
  Standard_EXPORT     Standard_Boolean IsReadOnly() const;


friend class CDM_Document;


  DEFINE_STANDARD_RTTI(CDM_Reference)

protected:




private: 

  
  Standard_EXPORT   CDM_Reference(const Handle(CDM_Document)& aFromDocument,const Handle(CDM_Document)& aToDocument,const Standard_Integer aReferenceIdentifier,const Standard_Integer aToDocumentVersion);
  
  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);
  
  Standard_EXPORT     void Update(const Handle(CDM_MetaData)& aMetaData) ;
  //! compares the actual document version with the <br>
//!          document version at the creation of the reference <br>
  Standard_EXPORT     Standard_Boolean IsUpToDate() const;
  
  Standard_EXPORT     void SetIsUpToDate() ;
  
  Standard_EXPORT     void UnsetToDocument(const Handle(CDM_MetaData)& aMetaData,const Handle(CDM_Application)& anApplication) ;
  //! returns  true if the  ToDocument has been retrieved <br>
//!          and opened. <br>
  Standard_EXPORT     Standard_Boolean IsOpened() const;
  
  Standard_EXPORT     Handle_CDM_Document Document() const;
  
  Standard_EXPORT     Handle_CDM_MetaData MetaData() const;
  
  Standard_EXPORT     Handle_CDM_Application Application() const;
  
  Standard_EXPORT     Standard_Boolean UseStorageConfiguration() const;
  
  Standard_EXPORT     Standard_Boolean IsInSession() const;
  
  Standard_EXPORT     Standard_Boolean IsStored() const;

Handle_CDM_Document myToDocument;
CDM_DocumentPointer myFromDocument;
Standard_Integer myReferenceIdentifier;
Handle_CDM_Application myApplication;
Handle_CDM_MetaData myMetaData;
Standard_Integer myDocumentVersion;
Standard_Boolean myUseStorageConfiguration;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif