Open CASCADE Technology  7.7.0.dev
Public Member Functions

BinDrivers_DocumentRetrievalDriver Class Reference

#include <BinDrivers_DocumentRetrievalDriver.hxx>

Inheritance diagram for BinDrivers_DocumentRetrievalDriver:
Inheritance graph
[legend]

Public Member Functions

 BinDrivers_DocumentRetrievalDriver ()
 Constructor. More...
 
virtual Handle< BinMDF_ADriverTableAttributeDrivers (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. More...
 
virtual void CheckShapeSection (const Storage_Position &thePos, Standard_IStream &theIS) override
 checks the shapes section can be correctly retrieved. More...
 
virtual void Clear () override
 Clears the NamedShape driver. More...
 
virtual void EnableQuickPartReading (const Handle< Message_Messenger > &theMessageDriver, Standard_Boolean theValue) override
 Enables reading in the quick part access mode. More...
 
- Public Member Functions inherited from BinLDrivers_DocumentRetrievalDriver
 BinLDrivers_DocumentRetrievalDriver ()
 Constructor. More...
 
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. 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 &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. 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...
 

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...
 
- 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 Message_ProgressRange &theRanges=Message_ProgressRange())
 Read the tree from the stream <theIS> to <theLabel> More...
 
virtual void ReadSection (BinLDrivers_DocumentSection &theSection, const Handle< CDM_Document > &theDoc, Standard_IStream &theIS)
 define the procedure of reading a section to file. More...
 
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. More...
 
- 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. More...
 
- Protected Attributes inherited from BinLDrivers_DocumentRetrievalDriver
Handle< BinMDF_ADriverTablemyDrivers
 
BinObjMgt_RRelocationTable myRelocTable
 
Handle< Message_MessengermyMsgDriver
 
- 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

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