Open CASCADE Technology  7.7.0
Public Member Functions | Protected Member Functions | Protected Attributes
XmlLDrivers_DocumentStorageDriver Class Reference

#include <XmlLDrivers_DocumentStorageDriver.hxx>

Inheritance diagram for XmlLDrivers_DocumentStorageDriver:
Inheritance graph
[legend]

Public Member Functions

 XmlLDrivers_DocumentStorageDriver (const TCollection_ExtendedString &theCopyright)
 
virtual void Write (const Handle< CDM_Document > &theDocument, const TCollection_ExtendedString &theFileName, const Message_ProgressRange &theRange=Message_ProgressRange()) override
 Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file. More...
 
virtual void Write (const Handle< CDM_Document > &theDocument, Standard_OStream &theOStream, const Message_ProgressRange &theRange=Message_ProgressRange()) override
 Write <theDocument> to theOStream. More...
 
virtual Handle< XmlMDF_ADriverTableAttributeDrivers (const Handle< Message_Messenger > &theMsgDriver)
 
- Public Member Functions inherited from PCDM_StorageDriver
virtual Handle< PCDM_DocumentMake (const Handle< CDM_Document > &aDocument)
 raises NotImplemented. More...
 
virtual void Make (const Handle< CDM_Document > &aDocument, PCDM_SequenceOfDocument &Documents)
 By default, puts in the Sequence the document returns by the previous Make method. More...
 
void SetFormat (const TCollection_ExtendedString &aformat)
 
TCollection_ExtendedString GetFormat () const
 
Standard_Boolean IsError () const
 
void SetIsError (const Standard_Boolean theIsError)
 
PCDM_StoreStatus GetStoreStatus () const
 
void SetStoreStatus (const PCDM_StoreStatus theStoreStatus)
 
- 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 Standard_Boolean WriteToDomDocument (const Handle< CDM_Document > &theDocument, XmlObjMgt_Element &thePDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
 
virtual Standard_Integer MakeDocument (const Handle< CDM_Document > &theDocument, XmlObjMgt_Element &thePDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
 
void AddNamespace (const TCollection_AsciiString &thePrefix, const TCollection_AsciiString &theURI)
 
virtual Standard_Boolean WriteShapeSection (XmlObjMgt_Element &thePDoc, const TDocStd_FormatVersion theStorageFormatVersion, const Message_ProgressRange &theRange=Message_ProgressRange())
 

Protected Attributes

Handle< XmlMDF_ADriverTablemyDrivers
 
XmlObjMgt_SRelocationTable myRelocTable
 

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

Constructor & Destructor Documentation

◆ XmlLDrivers_DocumentStorageDriver()

XmlLDrivers_DocumentStorageDriver::XmlLDrivers_DocumentStorageDriver ( const TCollection_ExtendedString theCopyright)

Member Function Documentation

◆ AddNamespace()

void XmlLDrivers_DocumentStorageDriver::AddNamespace ( const TCollection_AsciiString thePrefix,
const TCollection_AsciiString theURI 
)
protected

◆ AttributeDrivers()

virtual Handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentStorageDriver::AttributeDrivers ( const Handle< Message_Messenger > &  theMsgDriver)
virtual

◆ MakeDocument()

virtual Standard_Integer XmlLDrivers_DocumentStorageDriver::MakeDocument ( const Handle< CDM_Document > &  theDocument,
XmlObjMgt_Element thePDoc,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
protectedvirtual

◆ Write() [1/2]

virtual void XmlLDrivers_DocumentStorageDriver::Write ( const Handle< CDM_Document > &  aDocument,
const TCollection_ExtendedString aFileName,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
overridevirtual

Warning! raises DriverError if an error occurs during inside the Make method. stores the content of the Document into a new file.

by default Write will use Make method to build a persistent document and the Schema method to write the persistent document.

Reimplemented from PCDM_StorageDriver.

◆ Write() [2/2]

virtual void XmlLDrivers_DocumentStorageDriver::Write ( const Handle< CDM_Document > &  theDocument,
Standard_OStream theOStream,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
overridevirtual

Write <theDocument> to theOStream.

Reimplemented from PCDM_StorageDriver.

◆ WriteShapeSection()

virtual Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteShapeSection ( XmlObjMgt_Element thePDoc,
const TDocStd_FormatVersion  theStorageFormatVersion,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
protectedvirtual

◆ WriteToDomDocument()

virtual Standard_Boolean XmlLDrivers_DocumentStorageDriver::WriteToDomDocument ( const Handle< CDM_Document > &  theDocument,
XmlObjMgt_Element thePDoc,
const Message_ProgressRange theRange = Message_ProgressRange() 
)
protectedvirtual

Field Documentation

◆ myDrivers

Handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentStorageDriver::myDrivers
protected

◆ myRelocTable

XmlObjMgt_SRelocationTable XmlLDrivers_DocumentStorageDriver::myRelocTable
protected

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