Open CASCADE Technology  6.9.1
Public Member Functions | Protected Member Functions | Protected Attributes
XmlLDrivers_DocumentRetrievalDriver Class Reference

#include <XmlLDrivers_DocumentRetrievalDriver.hxx>

Inheritance diagram for XmlLDrivers_DocumentRetrievalDriver:
Inheritance graph
[legend]

Public Member Functions

 XmlLDrivers_DocumentRetrievalDriver ()
 
virtual TCollection_ExtendedString SchemaName () const
 
virtual void Make (const Handle< PCDM_Document > &PD, const Handle< CDM_Document > &TD)
 
virtual Handle< CDM_DocumentCreateDocument ()
 this method is called by the framework before the read method. More...
 
virtual void Read (const TCollection_ExtendedString &theFileName, const Handle< CDM_Document > &theNewDocument, const Handle< CDM_Application > &theApplication)
 Warning - raises DriverError if an error occurs during inside the Make method. retrieves the content of the file into a new Document. More...
 
virtual Handle< XmlMDF_ADriverTableAttributeDrivers (const Handle< CDM_MessageDriver > &theMsgDriver)
 
- Public Member Functions inherited from PCDM_RetrievalDriver
virtual void LoadExtensions (const Handle< Storage_Schema > &aSchema, const TColStd_SequenceOfExtendedString &Extensions, const Handle< CDM_MessageDriver > &theMsgDriver)
 
void SetFormat (const TCollection_ExtendedString &aformat)
 
TCollection_ExtendedString GetFormat () const
 
- Public Member Functions inherited from PCDM_Reader
PCDM_ReaderStatus GetStatus () const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const Handle_Standard_Type & DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Member Functions

virtual void ReadFromDomDocument (const XmlObjMgt_Element &theDomElement, const Handle< CDM_Document > &theNewDocument, const Handle< CDM_Application > &theApplication)
 
virtual Standard_Boolean MakeDocument (const XmlObjMgt_Element &thePDoc, const Handle< CDM_Document > &theTDoc)
 
virtual Handle< XmlMDF_ADriverReadShapeSection (const XmlObjMgt_Element &thePDoc, const Handle< CDM_MessageDriver > &theMsgDriver)
 
virtual void ShapeSetCleaning (const Handle< XmlMDF_ADriver > &theDriver)
 
virtual void PropagateDocumentVersion (const Standard_Integer theDocVersion)
 

Protected Attributes

Handle< XmlMDF_ADriverTablemyDrivers
 
XmlObjMgt_RRelocationTable myRelocTable
 
TCollection_ExtendedString myFileName
 
- Protected Attributes inherited from PCDM_Reader
PCDM_ReaderStatus myReaderStatus
 

Additional Inherited Members

- Static Public Member Functions inherited from PCDM_RetrievalDriver
static void RaiseIfUnknownTypes (const Handle< Storage_Schema > &aSchema, const TCollection_ExtendedString &aFileName)
 
static Standard_Integer DocumentVersion (const TCollection_ExtendedString &aFileName, const Handle< CDM_MessageDriver > &theMsgDriver)
 
static Standard_Integer ReferenceCounter (const TCollection_ExtendedString &aFileName, const Handle< CDM_MessageDriver > &theMsgDriver)
 

Constructor & Destructor Documentation

XmlLDrivers_DocumentRetrievalDriver::XmlLDrivers_DocumentRetrievalDriver ( )

Member Function Documentation

virtual Handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentRetrievalDriver::AttributeDrivers ( const Handle< CDM_MessageDriver > &  theMsgDriver)
virtual
virtual Handle< CDM_Document > XmlLDrivers_DocumentRetrievalDriver::CreateDocument ( )
virtual

this method is called by the framework before the read method.

Implements PCDM_Reader.

virtual void XmlLDrivers_DocumentRetrievalDriver::Make ( const Handle< PCDM_Document > &  PD,
const Handle< CDM_Document > &  TD 
)
virtual

Implements PCDM_RetrievalDriver.

virtual Standard_Boolean XmlLDrivers_DocumentRetrievalDriver::MakeDocument ( const XmlObjMgt_Element thePDoc,
const Handle< CDM_Document > &  theTDoc 
)
protectedvirtual
virtual void XmlLDrivers_DocumentRetrievalDriver::PropagateDocumentVersion ( const Standard_Integer  theDocVersion)
protectedvirtual
virtual void XmlLDrivers_DocumentRetrievalDriver::Read ( const TCollection_ExtendedString aFileName,
const Handle< CDM_Document > &  aNewDocument,
const Handle< CDM_Application > &  anApplication 
)
virtual

Warning - raises DriverError if an error occurs during inside the Make method. retrieves the content of the file into a new Document.

by default Read will use the Schema method to read the file into a persistent document. and the Make method to build a transient document.

Reimplemented from PCDM_RetrievalDriver.

virtual void XmlLDrivers_DocumentRetrievalDriver::ReadFromDomDocument ( const XmlObjMgt_Element theDomElement,
const Handle< CDM_Document > &  theNewDocument,
const Handle< CDM_Application > &  theApplication 
)
protectedvirtual
virtual Handle< XmlMDF_ADriver > XmlLDrivers_DocumentRetrievalDriver::ReadShapeSection ( const XmlObjMgt_Element thePDoc,
const Handle< CDM_MessageDriver > &  theMsgDriver 
)
protectedvirtual
virtual TCollection_ExtendedString XmlLDrivers_DocumentRetrievalDriver::SchemaName ( ) const
virtual

Implements PCDM_RetrievalDriver.

virtual void XmlLDrivers_DocumentRetrievalDriver::ShapeSetCleaning ( const Handle< XmlMDF_ADriver > &  theDriver)
protectedvirtual

Field Documentation

Handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentRetrievalDriver::myDrivers
protected
TCollection_ExtendedString XmlLDrivers_DocumentRetrievalDriver::myFileName
protected
XmlObjMgt_RRelocationTable XmlLDrivers_DocumentRetrievalDriver::myRelocTable
protected

The documentation for this class was generated from the following file: