PCDM_Reader Class Reference

#include <PCDM_Reader.hxx>

Inheritance diagram for PCDM_Reader:

Public Member Functions
virtual void	Read (const TCollection_ExtendedString &aFileName, const Handle< CDM_Document > &aNewDocument, const Handle< CDM_Application > &anApplication, const Handle< PCDM_ReaderFilter > &theFilter=Handle< PCDM_ReaderFilter >(), const Message_ProgressRange &theProgress=Message_ProgressRange())=0
	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())=0
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 Attributes
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 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.

Member Function Documentation

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< PCDM_ReaderFilter > & theFilter = Handle< PCDM_ReaderFilter >(), const Message_ProgressRange & theProgress = Message_ProgressRange() )

pure virtual

retrieves the content of the file into a new Document.

Implemented in BinLDrivers_DocumentRetrievalDriver, StdLDrivers_DocumentRetrievalDriver, and XmlLDrivers_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< PCDM_ReaderFilter > & theFilter = Handle< PCDM_ReaderFilter >(), const Message_ProgressRange & theProgress = Message_ProgressRange() )

pure virtual

Implemented in BinLDrivers_DocumentRetrievalDriver, StdLDrivers_DocumentRetrievalDriver, and XmlLDrivers_DocumentRetrievalDriver.

Field Documentation

myReaderStatus

PCDM_ReaderStatus PCDM_Reader::myReaderStatus

protected

---

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

• PCDM_Reader.hxx