Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
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 ()
 
void Read (const TCollection_ExtendedString &theFileName, const occ::handle< CDM_Document > &theNewDocument, const occ::handle< CDM_Application > &theApplication, const occ::handle< PCDM_ReaderFilter > &theFilter=occ::handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theRange=Message_ProgressRange()) override
 retrieves the content of the file into a new Document.
 
void Read (Standard_IStream &theIStream, const occ::handle< Storage_Data > &theStorageData, const occ::handle< CDM_Document > &theDoc, const occ::handle< CDM_Application > &theApplication, const occ::handle< PCDM_ReaderFilter > &theFilter=occ::handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theRange=Message_ProgressRange()) override
 
virtual occ::handle< XmlMDF_ADriverTableAttributeDrivers (const occ::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.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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.
 
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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Protected Member Functions

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

Protected Attributes

occ::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.
 
- Static Public Member Functions inherited from PCDM_RetrievalDriver
static int DocumentVersion (const TCollection_ExtendedString &theFileName, const occ::handle< Message_Messenger > &theMsgDriver)
 
static int ReferenceCounter (const TCollection_ExtendedString &theFileName, const occ::handle< Message_Messenger > &theMsgDriver)
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 

Constructor & Destructor Documentation

◆ XmlLDrivers_DocumentRetrievalDriver()

XmlLDrivers_DocumentRetrievalDriver::XmlLDrivers_DocumentRetrievalDriver ( )

Member Function Documentation

◆ AttributeDrivers()

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

◆ MakeDocument()

virtual bool XmlLDrivers_DocumentRetrievalDriver::MakeDocument ( const XmlObjMgt_Element & thePDoc,
const occ::handle< CDM_Document > & theTDoc,
const Message_ProgressRange & theRange = Message_ProgressRange() )
protectedvirtual

◆ Read() [1/2]

void XmlLDrivers_DocumentRetrievalDriver::Read ( const TCollection_ExtendedString & aFileName,
const occ::handle< CDM_Document > & aNewDocument,
const occ::handle< CDM_Application > & anApplication,
const occ::handle< PCDM_ReaderFilter > & theFilter = occ::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]

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

Implements PCDM_Reader.

◆ ReadFromDomDocument()

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

◆ ReadShapeSection()

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

◆ ShapeSetCleaning()

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

Field Documentation

◆ myDrivers

occ::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: