persistent implementation of storage. More...

#include <PCDM_StorageDriver.hxx>

Inheritance diagram for PCDM_StorageDriver:

[legend]

Public Member Functions
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	Write (const occ::handle< CDM_Document > &aDocument, const TCollection_ExtendedString &aFileName, 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.

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.

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.

Detailed Description

persistent implementation of storage.

The application must redefine one the two Make() methods. The first one, if the application wants to put only one document in the storage file.

The second method should be redefined to put additional document that could be used by the retrieval instead of the principal document, depending on the schema used during the retrieval. For example, a second document could be a standard CDMShape_Document. This means that a client application will already be able to extract a CDMShape_Document of the file, if the Shape Schema remains unchanged.

Member Function Documentation

◆ GetFormat()

TCollection_ExtendedString PCDM_StorageDriver::GetFormat ( ) const

◆ GetStoreStatus()

PCDM_StoreStatus PCDM_StorageDriver::GetStoreStatus ( ) const

◆ IsError()

bool PCDM_StorageDriver::IsError ( ) const

◆ Make() [1/2]

virtual occ::handle< PCDM_Document > PCDM_StorageDriver::Make ( const occ::handle< CDM_Document > & aDocument )

virtual

raises NotImplemented.

◆ Make() [2/2]

virtual void PCDM_StorageDriver::Make	(	const occ::handle< CDM_Document > &	aDocument,
		NCollection_Sequence< occ::handle< PCDM_Document > > &	Documents )

virtual

By default, puts in the Sequence the document returns by the previous Make method.

◆ SetFormat()

void PCDM_StorageDriver::SetFormat ( const TCollection_ExtendedString & aformat )

◆ SetIsError()

void PCDM_StorageDriver::SetIsError ( const bool theIsError )

◆ SetStoreStatus()

void PCDM_StorageDriver::SetStoreStatus ( const PCDM_StoreStatus theStoreStatus )

◆ Write() [1/2]

void PCDM_StorageDriver::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.

Implements PCDM_Writer.

Reimplemented in XmlLDrivers_DocumentStorageDriver.

◆ Write() [2/2]

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