summaryrefslogtreecommitdiff
path: root/inc/PCDM_RetrievalDriver.hxx
blob: 529bb9b05f5d9220383cfee53bafc28b1dade91a (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
// 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 _PCDM_RetrievalDriver_HeaderFile
#define _PCDM_RetrievalDriver_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_PCDM_RetrievalDriver_HeaderFile
#include <Handle_PCDM_RetrievalDriver.hxx>
#endif

#ifndef _TCollection_ExtendedString_HeaderFile
#include <TCollection_ExtendedString.hxx>
#endif
#ifndef _PCDM_Reader_HeaderFile
#include <PCDM_Reader.hxx>
#endif
#ifndef _Handle_CDM_MetaData_HeaderFile
#include <Handle_CDM_MetaData.hxx>
#endif
#ifndef _PCDM_ReferenceIterator_HeaderFile
#include <PCDM_ReferenceIterator.hxx>
#endif
#ifndef _Handle_CDM_Document_HeaderFile
#include <Handle_CDM_Document.hxx>
#endif
#ifndef _Handle_CDM_Application_HeaderFile
#include <Handle_CDM_Application.hxx>
#endif
#ifndef _Handle_PCDM_Document_HeaderFile
#include <Handle_PCDM_Document.hxx>
#endif
#ifndef _Handle_Storage_Schema_HeaderFile
#include <Handle_Storage_Schema.hxx>
#endif
#ifndef _Handle_CDM_MessageDriver_HeaderFile
#include <Handle_CDM_MessageDriver.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class Standard_NoSuchObject;
class PCDM_DriverError;
class CDM_MetaData;
class TCollection_ExtendedString;
class CDM_Document;
class CDM_Application;
class PCDM_Document;
class Storage_Schema;
class TColStd_SequenceOfExtendedString;
class CDM_MessageDriver;
class PCDM_SequenceOfReference;
class TCollection_AsciiString;



class PCDM_RetrievalDriver : public PCDM_Reader {

public:

  //!  Warning -  raises DriverError if an error occurs during inside the <br>
//!          Make method. <br>//! retrieves the content of the file into a new Document. <br>
//! <br>
//!          by  default  Read will  use the Schema method to read the file <br>
//!          into a persistent document. and the Make   method to build a <br>
//!          transient document. <br>
//! <br>
  Standard_EXPORT   virtual  void Read(const TCollection_ExtendedString& aFileName,const Handle(CDM_Document)& aNewDocument,const Handle(CDM_Application)& anApplication) ;
  
  Standard_EXPORT   virtual  void Make(const Handle(PCDM_Document)& aPCDM,const Handle(CDM_Document)& aNewDocument)  = 0;
  
  Standard_EXPORT   virtual  TCollection_ExtendedString SchemaName() const = 0;
  
  Standard_EXPORT   virtual  void LoadExtensions(const Handle(Storage_Schema)& aSchema,const TColStd_SequenceOfExtendedString& Extensions,const Handle(CDM_MessageDriver)& theMsgDriver) ;
  
  Standard_EXPORT   static  void RaiseIfUnknownTypes(const Handle(Storage_Schema)& aSchema,const TCollection_ExtendedString& aFileName) ;
  
  Standard_EXPORT   static  Standard_Integer DocumentVersion(const TCollection_ExtendedString& aFileName,const Handle(CDM_MessageDriver)& theMsgDriver) ;
  
  Standard_EXPORT   static  Standard_Integer ReferenceCounter(const TCollection_ExtendedString& aFileName,const Handle(CDM_MessageDriver)& theMsgDriver) ;
  
  Standard_EXPORT     void SetFormat(const TCollection_ExtendedString& aformat) ;
  
  Standard_EXPORT     TCollection_ExtendedString GetFormat() const;


friend   
  Standard_EXPORT   void PCDM_ReferenceIterator::Init(const Handle(CDM_MetaData)& aMetaData) ;


  DEFINE_STANDARD_RTTI(PCDM_RetrievalDriver)

protected:




private: 

  
  Standard_EXPORT   static  void References(const TCollection_ExtendedString& aFileName,PCDM_SequenceOfReference& theReferences,const Handle(CDM_MessageDriver)& theMsgDriver) ;
  
  Standard_EXPORT   static  void Extensions(const TCollection_ExtendedString& aFileName,TColStd_SequenceOfExtendedString& theExtensions,const Handle(CDM_MessageDriver)& theMsgDriver) ;
  
  Standard_EXPORT   static  void UserInfo(const TCollection_ExtendedString& aFileName,const TCollection_AsciiString& Start,const TCollection_AsciiString& End,TColStd_SequenceOfExtendedString& theUserInfo,const Handle(CDM_MessageDriver)& theMsgDriver) ;

TCollection_ExtendedString myFormat;


};





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


#endif