#include <BinLDrivers_DocumentRetrievalDriver.hxx>

Inheritance diagram for BinLDrivers_DocumentRetrievalDriver:

[legend]

Public Member Functions
	BinLDrivers_DocumentRetrievalDriver ()
	Constructor.
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 &theProgress=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 &theProgress=Message_ProgressRange()) override
virtual occ::handle< BinMDF_ADriverTable >	AttributeDrivers (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_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 int	ReadSubTree (Standard_IStream &theIS, const TDF_Label &theData, const occ::handle< PCDM_ReaderFilter > &theFilter, const bool &theQuickPart, const bool theReadMissing, const Message_ProgressRange &theRanges=Message_ProgressRange())
	Read the tree from the stream <theIS> to <theLabel>.
virtual void	ReadSection (BinLDrivers_DocumentSection &theSection, const occ::handle< CDM_Document > &theDoc, Standard_IStream &theIS)
	define the procedure of reading a section to file.
virtual void	ReadShapeSection (BinLDrivers_DocumentSection &theSection, Standard_IStream &theIS, const bool isMess=false, const Message_ProgressRange &theRange=Message_ProgressRange())
	define the procedure of reading a shapes section to file.
virtual void	CheckShapeSection (const Storage_Position &thePos, Standard_IStream &theIS)
	checks the shapes section can be correctly retrieved.
virtual void	Clear ()
	clears the reading-cash data in drivers if any.
virtual bool	CheckDocumentVersion (const int theFileVersion, const int theCurVersion)
	Check a file version(in which file was written) with a current version. Redefining this method is a chance for application to read files written by newer applications. The default implementation: if the version of the file is greater than the current or lesser than 2, then return false, else true.
virtual void	EnableQuickPartReading (const occ::handle< Message_Messenger > &, bool)
	Enables reading in the quick part access mode.

Static Protected Member Functions
static bool	IsQuickPart (const int theFileVer)
	Return true if retrieved document allows to read parts quickly.

Protected Attributes
occ::handle< BinMDF_ADriverTable >	myDrivers
BinObjMgt_RRelocationTable	myRelocTable
occ::handle< Message_Messenger >	myMsgDriver
Protected Attributes inherited from PCDM_Reader
PCDM_ReaderStatus	myReaderStatus

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.

Constructor & Destructor Documentation

◆ BinLDrivers_DocumentRetrievalDriver()

BinLDrivers_DocumentRetrievalDriver::BinLDrivers_DocumentRetrievalDriver ( )

Constructor.

Member Function Documentation

◆ AttributeDrivers()

virtual occ::handle< BinMDF_ADriverTable > BinLDrivers_DocumentRetrievalDriver::AttributeDrivers ( const occ::handle< Message_Messenger > & theMsgDriver )

virtual

Reimplemented in BinDrivers_DocumentRetrievalDriver, BinTObjDrivers_DocumentRetrievalDriver, and BinXCAFDrivers_DocumentRetrievalDriver.

◆ CheckDocumentVersion()

virtual bool BinLDrivers_DocumentRetrievalDriver::CheckDocumentVersion	(	const int	theFileVersion,
		const int	theCurVersion )

protectedvirtual

Check a file version(in which file was written) with a current version. Redefining this method is a chance for application to read files written by newer applications. The default implementation: if the version of the file is greater than the current or lesser than 2, then return false, else true.

◆ CheckShapeSection()

virtual void BinLDrivers_DocumentRetrievalDriver::CheckShapeSection	(	const Storage_Position &	thePos,
		Standard_IStream &	theIS )

protectedvirtual

checks the shapes section can be correctly retrieved.

Reimplemented in BinDrivers_DocumentRetrievalDriver.

◆ Clear()

virtual void BinLDrivers_DocumentRetrievalDriver::Clear ( )

protectedvirtual

clears the reading-cash data in drivers if any.

Reimplemented in BinDrivers_DocumentRetrievalDriver.

◆ EnableQuickPartReading()

virtual void BinLDrivers_DocumentRetrievalDriver::EnableQuickPartReading	(	const occ::handle< Message_Messenger > &	,
		bool	)

inlineprotectedvirtual

Enables reading in the quick part access mode.

Reimplemented in BinDrivers_DocumentRetrievalDriver.

◆ IsQuickPart()

bool BinLDrivers_DocumentRetrievalDriver::IsQuickPart ( const int theFileVer )

staticprotected

Return true if retrieved document allows to read parts quickly.

◆ Read() [1/2]

void BinLDrivers_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 &	theProgress = Message_ProgressRange() )

overridevirtual

retrieves the content of the file into a new Document.

Implements PCDM_Reader.

◆ Read() [2/2]

void BinLDrivers_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 &	theProgress = Message_ProgressRange() )

overridevirtual

Implements PCDM_Reader.

◆ ReadSection()

virtual void BinLDrivers_DocumentRetrievalDriver::ReadSection	(	BinLDrivers_DocumentSection &	theSection,
		const occ::handle< CDM_Document > &	theDoc,
		Standard_IStream &	theIS )

protectedvirtual

define the procedure of reading a section to file.

◆ ReadShapeSection()

virtual void BinLDrivers_DocumentRetrievalDriver::ReadShapeSection	(	BinLDrivers_DocumentSection &	theSection,
		Standard_IStream &	theIS,
		const bool	isMess = false,
		const Message_ProgressRange &	theRange = Message_ProgressRange() )

protectedvirtual

define the procedure of reading a shapes section to file.

Reimplemented in BinDrivers_DocumentRetrievalDriver.

◆ ReadSubTree()

virtual int BinLDrivers_DocumentRetrievalDriver::ReadSubTree	(	Standard_IStream &	theIS,
		const TDF_Label &	theData,
		const occ::handle< PCDM_ReaderFilter > &	theFilter,
		const bool &	theQuickPart,
		const bool	theReadMissing,
		const Message_ProgressRange &	theRanges = Message_ProgressRange() )

protectedvirtual

Read the tree from the stream <theIS> to <theLabel>.

Field Documentation

◆ myDrivers

occ::handle<BinMDF_ADriverTable> BinLDrivers_DocumentRetrievalDriver::myDrivers

protected

◆ myMsgDriver

occ::handle<Message_Messenger> BinLDrivers_DocumentRetrievalDriver::myMsgDriver

protected

◆ myRelocTable

BinObjMgt_RRelocationTable BinLDrivers_DocumentRetrievalDriver::myRelocTable

protected

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

BinLDrivers_DocumentRetrievalDriver.hxx

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ BinLDrivers_DocumentRetrievalDriver()

Member Function Documentation

◆ AttributeDrivers()

◆ CheckDocumentVersion()

◆ CheckShapeSection()

◆ Clear()

◆ EnableQuickPartReading()

◆ IsQuickPart()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadSection()

◆ ReadShapeSection()

◆ ReadSubTree()

Field Documentation

◆ myDrivers

◆ myMsgDriver

◆ myRelocTable