XmlLDrivers_DocumentStorageDriver Class Reference

#include <XmlLDrivers_DocumentStorageDriver.hxx>

Inheritance diagram for XmlLDrivers_DocumentStorageDriver:

Public Member Functions
	XmlLDrivers_DocumentStorageDriver (const TCollection_ExtendedString &theCopyright)
void	Write (const occ::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.
void	Write (const occ::handle< CDM_Document > &theDocument, Standard_OStream &theOStream, const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Write <theDocument> to theOStream.
virtual occ::handle< XmlMDF_ADriverTable >	AttributeDrivers (const occ::handle< Message_Messenger > &theMsgDriver)
Public Member Functions inherited from PCDM_StorageDriver
virtual occ::handle< PCDM_Document >	Make (const occ::handle< CDM_Document > &aDocument)
	raises NotImplemented.
virtual void	Make (const occ::handle< CDM_Document > &aDocument, NCollection_Sequence< occ::handle< PCDM_Document > > &Documents)
	By default, puts in the Sequence the document returns by the previous Make method.
void	SetFormat (const TCollection_ExtendedString &aformat)
TCollection_ExtendedString	GetFormat () const
bool	IsError () const
void	SetIsError (const bool theIsError)
PCDM_StoreStatus	GetStoreStatus () const
void	SetStoreStatus (const PCDM_StoreStatus theStoreStatus)
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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
virtual bool	WriteToDomDocument (const occ::handle< CDM_Document > &theDocument, XmlObjMgt_Element &thePDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
virtual int	MakeDocument (const occ::handle< CDM_Document > &theDocument, XmlObjMgt_Element &thePDoc, const Message_ProgressRange &theRange=Message_ProgressRange())
void	AddNamespace (const TCollection_AsciiString &thePrefix, const TCollection_AsciiString &theURI)
virtual bool	WriteShapeSection (XmlObjMgt_Element &thePDoc, const TDocStd_FormatVersion theStorageFormatVersion, const Message_ProgressRange &theRange=Message_ProgressRange())

Protected Attributes
occ::handle< XmlMDF_ADriverTable >	myDrivers
XmlObjMgt_SRelocationTable	myRelocTable

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.

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 occ::handle< XmlMDF_ADriverTable > XmlLDrivers_DocumentStorageDriver::AttributeDrivers ( const occ::handle< Message_Messenger > & theMsgDriver )

virtual

Reimplemented in XmlDrivers_DocumentStorageDriver, XmlTObjDrivers_DocumentStorageDriver, and XmlXCAFDrivers_DocumentStorageDriver.

MakeDocument()

virtual int XmlLDrivers_DocumentStorageDriver::MakeDocument ( const occ::handle< CDM_Document > & theDocument, XmlObjMgt_Element & thePDoc, const Message_ProgressRange & theRange = Message_ProgressRange() )

protectedvirtual

Write() [1/2]

void XmlLDrivers_DocumentStorageDriver::Write ( const occ::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]

void XmlLDrivers_DocumentStorageDriver::Write ( const occ::handle< CDM_Document > & theDocument, Standard_OStream & theOStream, const Message_ProgressRange & theRange = Message_ProgressRange() )

overridevirtual

Write <theDocument> to theOStream.

Reimplemented from PCDM_StorageDriver.

WriteShapeSection()

virtual bool XmlLDrivers_DocumentStorageDriver::WriteShapeSection ( XmlObjMgt_Element & thePDoc, const TDocStd_FormatVersion theStorageFormatVersion, const Message_ProgressRange & theRange = Message_ProgressRange() )

protectedvirtual

Reimplemented in XmlDrivers_DocumentStorageDriver.

WriteToDomDocument()

virtual bool XmlLDrivers_DocumentStorageDriver::WriteToDomDocument ( const occ::handle< CDM_Document > & theDocument, XmlObjMgt_Element & thePDoc, const Message_ProgressRange & theRange = Message_ProgressRange() )

protectedvirtual

Field Documentation

myDrivers

occ::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:

• XmlLDrivers_DocumentStorageDriver.hxx