Open CASCADE Technology 7.8.2.dev
|
#include <BinLDrivers_DocumentRetrievalDriver.hxx>
Public Member Functions | |
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 |
virtual Handle< BinMDF_ADriverTable > | AttributeDrivers (const 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 () |
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. | |
Protected Member Functions | |
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 void | ReadShapeSection (BinLDrivers_DocumentSection &theSection, Standard_IStream &theIS, const Standard_Boolean isMess=Standard_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 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. | |
virtual void | EnableQuickPartReading (const Handle< Message_Messenger > &, Standard_Boolean) |
Enables reading in the quick part access mode. | |
Static Protected Member Functions | |
static Standard_Boolean | IsQuickPart (const Standard_Integer theFileVer) |
Return true if retrieved document allows to read parts quickly. | |
Protected Attributes | |
Handle< BinMDF_ADriverTable > | myDrivers |
BinObjMgt_RRelocationTable | myRelocTable |
Handle< Message_Messenger > | myMsgDriver |
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 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 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. | |
BinLDrivers_DocumentRetrievalDriver::BinLDrivers_DocumentRetrievalDriver | ( | ) |
Constructor.
|
virtual |
|
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.
|
protectedvirtual |
checks the shapes section can be correctly retrieved.
Reimplemented in BinDrivers_DocumentRetrievalDriver.
|
protectedvirtual |
clears the reading-cash data in drivers if any.
Reimplemented in BinDrivers_DocumentRetrievalDriver.
|
inlineprotectedvirtual |
Enables reading in the quick part access mode.
Reimplemented in BinDrivers_DocumentRetrievalDriver.
|
staticprotected |
Return true if retrieved document allows to read parts quickly.
|
overridevirtual |
retrieves the content of the file into a new Document.
Implements PCDM_Reader.
|
overridevirtual |
Implements PCDM_Reader.
|
protectedvirtual |
define the procedure of reading a section to file.
|
protectedvirtual |
define the procedure of reading a shapes section to file.
Reimplemented in BinDrivers_DocumentRetrievalDriver.
|
protectedvirtual |
Read the tree from the stream <theIS> to <theLabel>
|
protected |
|
protected |
|
protected |