Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Attributes
PCDM_Reader Class Referenceabstract

#include <PCDM_Reader.hxx>

Inheritance diagram for PCDM_Reader:
Inheritance graph
[legend]

Public Member Functions

virtual Handle< CDM_DocumentCreateDocument ()=0
 this method is called by the framework before the read method. More...
 
virtual void Read (const TCollection_ExtendedString &aFileName, const Handle< CDM_Document > &aNewDocument, const Handle< CDM_Application > &anApplication, const Handle< Message_ProgressIndicator > &theProgress=NULL)=0
 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< Message_ProgressIndicator > &theProgress=NULL)=0
 
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 Attributes

PCDM_ReaderStatus myReaderStatus
 

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 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...
 

Member Function Documentation

◆ CreateDocument()

virtual Handle< CDM_Document > PCDM_Reader::CreateDocument ( )
pure virtual

this method is called by the framework before the read method.

Implemented in BinLDrivers_DocumentRetrievalDriver, XmlLDrivers_DocumentRetrievalDriver, and StdLDrivers_DocumentRetrievalDriver.

◆ GetStatus()

PCDM_ReaderStatus PCDM_Reader::GetStatus ( ) const

◆ Read() [1/2]

virtual void PCDM_Reader::Read ( const TCollection_ExtendedString aFileName,
const Handle< CDM_Document > &  aNewDocument,
const Handle< CDM_Application > &  anApplication,
const Handle< Message_ProgressIndicator > &  theProgress = NULL 
)
pure virtual

retrieves the content of the file into a new Document.

Implemented in BinLDrivers_DocumentRetrievalDriver, XmlLDrivers_DocumentRetrievalDriver, and StdLDrivers_DocumentRetrievalDriver.

◆ Read() [2/2]

virtual void PCDM_Reader::Read ( Standard_IStream theIStream,
const Handle< Storage_Data > &  theStorageData,
const Handle< CDM_Document > &  theDoc,
const Handle< CDM_Application > &  theApplication,
const Handle< Message_ProgressIndicator > &  theProgress = NULL 
)
pure virtual

Field Documentation

◆ myReaderStatus

PCDM_ReaderStatus PCDM_Reader::myReaderStatus
protected

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