Open CASCADE Technology  7.5.0
Public Member Functions | Protected Member Functions
StdLDrivers_DocumentRetrievalDriver Class Reference

retrieval driver of a Part document More...

#include <StdLDrivers_DocumentRetrievalDriver.hxx>

Inheritance diagram for StdLDrivers_DocumentRetrievalDriver:
Inheritance graph
[legend]

Public Member Functions

virtual Handle< CDM_DocumentCreateDocument () override
 Create an empty TDocStd_Document. More...
 
virtual void Read (const TCollection_ExtendedString &theFileName, const Handle< CDM_Document > &theNewDocument, const Handle< CDM_Application > &theApplication, const Message_ProgressRange &theRange=Message_ProgressRange()) override
 Retrieve the content of a 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 Message_ProgressRange &theRange=Message_ProgressRange()) override
 Override pure virtual method (raises exception Standard_NotImplemented) More...
 
- 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...
 

Protected Member Functions

virtual void bindTypes (StdObjMgt_MapOfInstantiators &theMap)
 Register types. 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 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.

◆ CreateDocument()

virtual Handle< CDM_Document > StdLDrivers_DocumentRetrievalDriver::CreateDocument ( )
overridevirtual

Create an empty TDocStd_Document.

Implements PCDM_Reader.

◆ Read() [1/2]

virtual void StdLDrivers_DocumentRetrievalDriver::Read ( const TCollection_ExtendedString theFileName,
const Handle< CDM_Document > &  theNewDocument,
const Handle< CDM_Application > &  theApplication,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
overridevirtual

Retrieve the content of a file into a new document.

Implements PCDM_Reader.

◆ Read() [2/2]

virtual void StdLDrivers_DocumentRetrievalDriver::Read ( Standard_IStream theIStream,
const Handle< Storage_Data > &  theStorageData,
const Handle< CDM_Document > &  theDoc,
const Handle< CDM_Application > &  theApplication,
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: