Open CASCADE Technology  7.4.1.dev
Public Member Functions | Static Public Member Functions
PCDM_ReadWriter Class Referenceabstract

#include <PCDM_ReadWriter.hxx>

Inheritance diagram for PCDM_ReadWriter:
Inheritance graph
[legend]

Public Member Functions

virtual TCollection_AsciiString Version () const =0
 returns PCDM_ReadWriter_1. More...
 
virtual void WriteReferenceCounter (const Handle< Storage_Data > &aData, const Handle< CDM_Document > &aDocument) const =0
 
virtual void WriteReferences (const Handle< Storage_Data > &aData, const Handle< CDM_Document > &aDocument, const TCollection_ExtendedString &theReferencerFileName) const =0
 
virtual void WriteExtensions (const Handle< Storage_Data > &aData, const Handle< CDM_Document > &aDocument) const =0
 
virtual void WriteVersion (const Handle< Storage_Data > &aData, const Handle< CDM_Document > &aDocument) const =0
 
virtual Standard_Integer ReadReferenceCounter (const TCollection_ExtendedString &theFileName, const Handle< Message_Messenger > &theMsgDriver) const =0
 
virtual void ReadReferences (const TCollection_ExtendedString &aFileName, PCDM_SequenceOfReference &theReferences, const Handle< Message_Messenger > &theMsgDriver) const =0
 
virtual void ReadExtensions (const TCollection_ExtendedString &aFileName, TColStd_SequenceOfExtendedString &theExtensions, const Handle< Message_Messenger > &theMsgDriver) const =0
 
virtual Standard_Integer ReadDocumentVersion (const TCollection_ExtendedString &aFileName, const Handle< Message_Messenger > &theMsgDriver) const =0
 
- 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...
 

Static Public Member Functions

static void Open (const Handle< Storage_BaseDriver > &aDriver, const TCollection_ExtendedString &aFileName, const Storage_OpenMode anOpenMode)
 
static Handle< PCDM_ReadWriterReader (const TCollection_ExtendedString &aFileName)
 returns the convenient Reader for a File. More...
 
static Handle< PCDM_ReadWriterWriter ()
 
static void WriteFileFormat (const Handle< Storage_Data > &aData, const Handle< CDM_Document > &aDocument)
 
static TCollection_ExtendedString FileFormat (const TCollection_ExtendedString &aFileName)
 tries to get a format in the file. returns an empty string if the file could not be read or does not have a FileFormat information. More...
 
static TCollection_ExtendedString FileFormat (Standard_IStream &theIStream, Handle< Storage_Data > &theData)
 tries to get a format from the stream. returns an empty string if the file could not be read or does not have a FileFormat information. 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Member Function Documentation

◆ FileFormat() [1/2]

static TCollection_ExtendedString PCDM_ReadWriter::FileFormat ( const TCollection_ExtendedString aFileName)
static

tries to get a format in the file. returns an empty string if the file could not be read or does not have a FileFormat information.

◆ FileFormat() [2/2]

static TCollection_ExtendedString PCDM_ReadWriter::FileFormat ( Standard_IStream theIStream,
Handle< Storage_Data > &  theData 
)
static

tries to get a format from the stream. returns an empty string if the file could not be read or does not have a FileFormat information.

◆ Open()

static void PCDM_ReadWriter::Open ( const Handle< Storage_BaseDriver > &  aDriver,
const TCollection_ExtendedString aFileName,
const Storage_OpenMode  anOpenMode 
)
static

◆ ReadDocumentVersion()

virtual Standard_Integer PCDM_ReadWriter::ReadDocumentVersion ( const TCollection_ExtendedString aFileName,
const Handle< Message_Messenger > &  theMsgDriver 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ Reader()

static Handle< PCDM_ReadWriter > PCDM_ReadWriter::Reader ( const TCollection_ExtendedString aFileName)
static

returns the convenient Reader for a File.

◆ ReadExtensions()

virtual void PCDM_ReadWriter::ReadExtensions ( const TCollection_ExtendedString aFileName,
TColStd_SequenceOfExtendedString theExtensions,
const Handle< Message_Messenger > &  theMsgDriver 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ ReadReferenceCounter()

virtual Standard_Integer PCDM_ReadWriter::ReadReferenceCounter ( const TCollection_ExtendedString theFileName,
const Handle< Message_Messenger > &  theMsgDriver 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ ReadReferences()

virtual void PCDM_ReadWriter::ReadReferences ( const TCollection_ExtendedString aFileName,
PCDM_SequenceOfReference theReferences,
const Handle< Message_Messenger > &  theMsgDriver 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ Version()

virtual TCollection_AsciiString PCDM_ReadWriter::Version ( ) const
pure virtual

returns PCDM_ReadWriter_1.

Implemented in PCDM_ReadWriter_1.

◆ WriteExtensions()

virtual void PCDM_ReadWriter::WriteExtensions ( const Handle< Storage_Data > &  aData,
const Handle< CDM_Document > &  aDocument 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ WriteFileFormat()

static void PCDM_ReadWriter::WriteFileFormat ( const Handle< Storage_Data > &  aData,
const Handle< CDM_Document > &  aDocument 
)
static

◆ Writer()

static Handle< PCDM_ReadWriter > PCDM_ReadWriter::Writer ( )
static

◆ WriteReferenceCounter()

virtual void PCDM_ReadWriter::WriteReferenceCounter ( const Handle< Storage_Data > &  aData,
const Handle< CDM_Document > &  aDocument 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ WriteReferences()

virtual void PCDM_ReadWriter::WriteReferences ( const Handle< Storage_Data > &  aData,
const Handle< CDM_Document > &  aDocument,
const TCollection_ExtendedString theReferencerFileName 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.

◆ WriteVersion()

virtual void PCDM_ReadWriter::WriteVersion ( const Handle< Storage_Data > &  aData,
const Handle< CDM_Document > &  aDocument 
) const
pure virtual

Implemented in PCDM_ReadWriter_1.


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