Open CASCADE Technology  7.7.0
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 void Read (const TCollection_ExtendedString &theFileName, const Handle< CDM_Document > &theNewDocument, const Handle< CDM_Application > &theApplication, const Handle< PCDM_ReaderFilter > &theFilter=Handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theRange=Message_ProgressRange()) override
 retrieves the content of the file into a new Document. More...
 
virtual void Read (Standard_IStream &theIStream, const Handle< Storage_Data > &theStorageData, const Handle< CDM_Document > &theDoc, const Handle< CDM_Application > &theApplication, const Handle< PCDM_ReaderFilter > &theFilter=Handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theRange=Message_ProgressRange()) override
 
virtual Handle< XmlMDF_ADriverTableAttributeDrivers (const Handle< Message_Messenger > &theMsgDriver)
 
- Public Member Functions inherited from PCDM_RetrievalDriver
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 opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

virtual void ReadFromDomDocument (const XmlObjMgt_Element &theDomElement, const Handle< CDM_Document > &theNewDocument, const Handle< CDM_Application > &theApplication, const Message_ProgressRange &theRange=Message_ProgressRange())
 
virtual Standard_Boolean MakeDocument (const XmlObjMgt_Element &thePDoc, const Handle< CDM_Document > &theTDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
 
virtual Handle< XmlMDF_ADriverReadShapeSection (const XmlObjMgt_Element &thePDoc, const Handle< Message_Messenger > &theMsgDriver, const Message_ProgressRange &theRange=Message_ProgressRange())
 
virtual void ShapeSetCleaning (const Handle< XmlMDF_ADriver > &theDriver)
 

Protected Attributes

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

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from PCDM_RetrievalDriver
static Standard_Integer DocumentVersion (const TCollection_ExtendedString &theFileName, const Handle< Message_Messenger > &theMsgDriver)
 
static Standard_Integer ReferenceCounter (const TCollection_ExtendedString &theFileName, const Handle< Message_Messenger > &theMsgDriver)
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Constructor & Destructor Documentation

◆ XmlLDrivers_DocumentRetrievalDriver()

XmlLDrivers_DocumentRetrievalDriver::XmlLDrivers_DocumentRetrievalDriver ( )

Member Function Documentation

◆ AttributeDrivers()

virtual Handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentRetrievalDriver::AttributeDrivers ( const Handle< Message_Messenger > &  theMsgDriver)
virtual

◆ MakeDocument()

virtual Standard_Boolean XmlLDrivers_DocumentRetrievalDriver::MakeDocument ( const XmlObjMgt_Element thePDoc,
const Handle< CDM_Document > &  theTDoc,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
protectedvirtual

◆ Read() [1/2]

virtual void XmlLDrivers_DocumentRetrievalDriver::Read ( const TCollection_ExtendedString aFileName,
const Handle< CDM_Document > &  aNewDocument,
const Handle< CDM_Application > &  anApplication,
const Handle< PCDM_ReaderFilter > &  theFilter = HandlePCDM_ReaderFilter >(),
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
overridevirtual

retrieves the content of the file into a new Document.

Implements PCDM_Reader.

◆ Read() [2/2]

virtual void XmlLDrivers_DocumentRetrievalDriver::Read ( Standard_IStream theIStream,
const Handle< Storage_Data > &  theStorageData,
const Handle< CDM_Document > &  theDoc,
const Handle< CDM_Application > &  theApplication,
const Handle< PCDM_ReaderFilter > &  theFilter = HandlePCDM_ReaderFilter >(),
const Message_ProgressRange theRange = Message_ProgressRange() 
)
overridevirtual

Implements PCDM_Reader.

◆ ReadFromDomDocument()

virtual void XmlLDrivers_DocumentRetrievalDriver::ReadFromDomDocument ( const XmlObjMgt_Element theDomElement,
const Handle< CDM_Document > &  theNewDocument,
const Handle< CDM_Application > &  theApplication,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
protectedvirtual

◆ ReadShapeSection()

virtual Handle< XmlMDF_ADriver > XmlLDrivers_DocumentRetrievalDriver::ReadShapeSection ( const XmlObjMgt_Element thePDoc,
const Handle< Message_Messenger > &  theMsgDriver,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
protectedvirtual

◆ ShapeSetCleaning()

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

Field Documentation

◆ myDrivers

Handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentRetrievalDriver::myDrivers
protected

◆ myFileName

TCollection_ExtendedString XmlLDrivers_DocumentRetrievalDriver::myFileName
protected

◆ myRelocTable

XmlObjMgt_RRelocationTable XmlLDrivers_DocumentRetrievalDriver::myRelocTable
protected

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