BinDrivers_DocumentRetrievalDriver Class Reference

#include <BinDrivers_DocumentRetrievalDriver.hxx>

Inheritance diagram for BinDrivers_DocumentRetrievalDriver:

Public Member Functions
	BinDrivers_DocumentRetrievalDriver ()
	Constructor.
virtual Handle< BinMDF_ADriverTable >	AttributeDrivers (const Handle< Message_Messenger > &theMsgDriver) override
virtual void	ReadShapeSection (BinLDrivers_DocumentSection &theSection, Standard_IStream &theIS, const Standard_Boolean isMess=Standard_False, const Message_ProgressRange &theRange=Message_ProgressRange()) override
	define the procedure of reading a shapes section to file.
virtual void	CheckShapeSection (const Storage_Position &thePos, Standard_IStream &theIS) override
	checks the shapes section can be correctly retrieved.
virtual void	Clear () override
	Clears the NamedShape driver.
virtual void	EnableQuickPartReading (const Handle< Message_Messenger > &theMessageDriver, Standard_Boolean theValue) override
	Enables reading in the quick part access mode.
Public Member Functions inherited from BinLDrivers_DocumentRetrievalDriver
	BinLDrivers_DocumentRetrievalDriver ()
	Constructor.
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 &theProgress=Message_ProgressRange()) override
	retrieves the content of the file into a new Document.
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 &theProgress=Message_ProgressRange()) override
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 ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 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 Member Functions inherited from BinLDrivers_DocumentRetrievalDriver
virtual Standard_Integer	ReadSubTree (Standard_IStream &theIS, const TDF_Label &theData, const Handle< PCDM_ReaderFilter > &theFilter, const Standard_Boolean &theQuickPart, const Standard_Boolean theReadMissing, const Message_ProgressRange &theRanges=Message_ProgressRange())
	Read the tree from the stream <theIS> to <theLabel>
virtual void	ReadSection (BinLDrivers_DocumentSection &theSection, const Handle< CDM_Document > &theDoc, Standard_IStream &theIS)
	define the procedure of reading a section to file.
virtual Standard_Boolean	CheckDocumentVersion (const Standard_Integer theFileVersion, const Standard_Integer 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.
Static Protected Member Functions inherited from BinLDrivers_DocumentRetrievalDriver
static Standard_Boolean	IsQuickPart (const Standard_Integer theFileVer)
	Return true if retrieved document allows to read parts quickly.
Protected Attributes inherited from BinLDrivers_DocumentRetrievalDriver
Handle< BinMDF_ADriverTable >	myDrivers
BinObjMgt_RRelocationTable	myRelocTable
Handle< Message_Messenger >	myMsgDriver
Protected Attributes inherited from PCDM_Reader
PCDM_ReaderStatus	myReaderStatus

Constructor & Destructor Documentation

BinDrivers_DocumentRetrievalDriver()

BinDrivers_DocumentRetrievalDriver::BinDrivers_DocumentRetrievalDriver

(

)

Constructor.

Member Function Documentation

AttributeDrivers()

virtual Handle< BinMDF_ADriverTable > BinDrivers_DocumentRetrievalDriver::AttributeDrivers ( const Handle< Message_Messenger > & theMsgDriver )

overridevirtual

Reimplemented from BinLDrivers_DocumentRetrievalDriver.

Reimplemented in BinXCAFDrivers_DocumentRetrievalDriver.

CheckShapeSection()

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

overridevirtual

checks the shapes section can be correctly retrieved.

Reimplemented from BinLDrivers_DocumentRetrievalDriver.

Clear()

virtual void BinDrivers_DocumentRetrievalDriver::Clear ( )

overridevirtual

Clears the NamedShape driver.

Reimplemented from BinLDrivers_DocumentRetrievalDriver.

EnableQuickPartReading()

virtual void BinDrivers_DocumentRetrievalDriver::EnableQuickPartReading ( const Handle< Message_Messenger > & theMessageDriver, Standard_Boolean theValue )

overridevirtual

Enables reading in the quick part access mode.

Reimplemented from BinLDrivers_DocumentRetrievalDriver.

ReadShapeSection()

virtual void BinDrivers_DocumentRetrievalDriver::ReadShapeSection ( BinLDrivers_DocumentSection & theSection, Standard_IStream & theIS, const Standard_Boolean isMess = Standard_False, const Message_ProgressRange & theRange = Message_ProgressRange() )

overridevirtual

define the procedure of reading a shapes section to file.

Reimplemented from BinLDrivers_DocumentRetrievalDriver.

---

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

• BinDrivers_DocumentRetrievalDriver.hxx