summaryrefslogtreecommitdiff
path: root/inc/CDM_MetaData.hxx
blob: a9d77ffc7000b6be19ff5977ed873263ccba1da9 (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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// 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_MetaData_HeaderFile
#define _CDM_MetaData_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_CDM_MetaData_HeaderFile
#include <Handle_CDM_MetaData.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _CDM_DocumentPointer_HeaderFile
#include <CDM_DocumentPointer.hxx>
#endif
#ifndef _TCollection_ExtendedString_HeaderFile
#include <TCollection_ExtendedString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Transient_HeaderFile
#include <Standard_Transient.hxx>
#endif
#ifndef _Handle_CDM_MetaData_HeaderFile
#include <Handle_CDM_MetaData.hxx>
#endif
#ifndef _CDM_Document_HeaderFile
#include <CDM_Document.hxx>
#endif
#ifndef _Handle_CDM_Document_HeaderFile
#include <Handle_CDM_Document.hxx>
#endif
#ifndef _CDM_Application_HeaderFile
#include <CDM_Application.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
#ifndef _Handle_CDM_Application_HeaderFile
#include <Handle_CDM_Application.hxx>
#endif
class Standard_NoSuchObject;
class CDM_Reference;
class CDM_Document;
class TCollection_ExtendedString;
class CDM_MetaDataLookUpTable;
class CDM_Application;



class CDM_MetaData : public Standard_Transient {

public:

  
  Standard_EXPORT   static  Handle_CDM_MetaData LookUp(const TCollection_ExtendedString& aFolder,const TCollection_ExtendedString& aName,const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly) ;
  
  Standard_EXPORT   static  Handle_CDM_MetaData LookUp(const TCollection_ExtendedString& aFolder,const TCollection_ExtendedString& aName,const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aVersion,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly) ;
  
  Standard_EXPORT     Standard_Boolean IsRetrieved() const;
  
  Standard_EXPORT     Handle_CDM_Document Document() const;
  //! returns the folder in which the meta-data has to be created <br>
//!          or has to be found. <br>
//! <br>
  Standard_EXPORT     TCollection_ExtendedString Folder() const;
  //! returns the name under which the meta-data has to be created <br>
//!          or has to be found. <br>
//! <br>
  Standard_EXPORT     TCollection_ExtendedString Name() const;
  //! returns the version under which the meta-data has to be found. <br>
//! Warning: raises NoSuchObject from Standard if no Version has been defined <br>
  Standard_EXPORT     TCollection_ExtendedString Version() const;
  //! indicates that the version has to be taken into account when <br>
//!          searching the corresponding meta-data. <br>
  Standard_EXPORT     Standard_Boolean HasVersion() const;
  
  Standard_EXPORT     TCollection_ExtendedString FileName() const;
  
  Standard_EXPORT     Standard_OStream& Print(Standard_OStream& anOStream) const;
Standard_OStream& operator << (Standard_OStream& anOStream);
  
  Standard_EXPORT     TCollection_ExtendedString Path() const;
  
  Standard_EXPORT     void UnsetDocument() ;
  
  Standard_EXPORT     Standard_Boolean IsReadOnly() const;
  
  Standard_EXPORT     void SetIsReadOnly() ;
  
  Standard_EXPORT     void UnsetIsReadOnly() ;


friend class CDM_Reference;
friend   //!  associates database  information to  a document which <br>
//!          has been stored.  The name of the  document is now the <br>
//!          name which has beenused to store the data. <br>
  Standard_EXPORT   void CDM_Document::SetMetaData(const Handle(CDM_MetaData)& aMetaData) ;
friend   
  Standard_EXPORT   void CDM_Application::SetDocumentVersion(const Handle(CDM_Document)& aDocument,const Handle(CDM_MetaData)& aMetaData) const;


  DEFINE_STANDARD_RTTI(CDM_MetaData)

protected:




private: 

  
  Standard_EXPORT   CDM_MetaData(const TCollection_ExtendedString& aFolder,const TCollection_ExtendedString& aName,const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly);
  
  Standard_EXPORT   CDM_MetaData(const TCollection_ExtendedString& aFolder,const TCollection_ExtendedString& aName,const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aVersion,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly);
  
  Standard_EXPORT     void SetDocument(const Handle(CDM_Document)& aDocument) ;
  
  Standard_EXPORT   static const CDM_MetaDataLookUpTable& LookUpTable() ;
  
  Standard_EXPORT     Standard_Integer DocumentVersion(const Handle(CDM_Application)& anApplication) ;

Standard_Boolean myIsRetrieved;
CDM_DocumentPointer myDocument;
TCollection_ExtendedString myFolder;
TCollection_ExtendedString myName;
TCollection_ExtendedString myVersion;
Standard_Boolean myHasVersion;
TCollection_ExtendedString myFileName;
TCollection_ExtendedString myPath;
Standard_Integer myDocumentVersion;
Standard_Boolean myIsReadOnly;


};





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


#endif