StdLDrivers_DocumentRetrievalDriver Class Reference

retrieval driver of a Part document More...

#include <StdLDrivers_DocumentRetrievalDriver.hxx>

Inheritance diagram for StdLDrivers_DocumentRetrievalDriver:

Public Member Functions
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
	Retrieve the content of a 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
	Override pure virtual method (raises exception Standard_NotImplemented).
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_Transient &	operator= (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_Transient *	This () 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	bindTypes (StdObjMgt_MapOfInstantiators &theMap)
	Register types.

Additional Inherited Members
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 constexpr const char *	get_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.
Protected Attributes inherited from PCDM_Reader
PCDM_ReaderStatus	myReaderStatus

Detailed Description

retrieval driver of a Part document

Member Function Documentation

bindTypes()

virtual void StdLDrivers_DocumentRetrievalDriver::bindTypes ( StdObjMgt_MapOfInstantiators & theMap )

protectedvirtual

Register types.

Reimplemented in StdDrivers_DocumentRetrievalDriver.

Read() [1/2]

void StdLDrivers_DocumentRetrievalDriver::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() )

overridevirtual

Retrieve the content of a file into a new document.

Implements PCDM_Reader.

Read() [2/2]

void StdLDrivers_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::handle< PCDM_ReaderFilter >(), const Message_ProgressRange & theRange = Message_ProgressRange() )

overridevirtual

Override pure virtual method (raises exception Standard_NotImplemented).

Implements PCDM_Reader.

---

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

• StdLDrivers_DocumentRetrievalDriver.hxx