CDM_Application Class Reference

#include <CDM_Application.hxx>

Inheritance diagram for CDM_Application:

Public Member Functions
virtual	Handle (Resource_Manager) Resources()=0
	The manager returned by this virtual method will be used to search for Format.Retrieval resource items.
virtual	Handle (Message_Messenger) MessageDriver()
	Returns default messenger;.
virtual void	BeginOfUpdate (const Handle(CDM_Document)&aDocument)
	this method is called before the update of a document. By default, writes in MessageDriver().
virtual void	EndOfUpdate (const Handle(CDM_Document)&aDocument, const Standard_Boolean theStatus, const TCollection_ExtendedString &ErrorString)
	this method is called after the update of a document. By default, writes in MessageDriver().
void	Write (const Standard_ExtString aString)
	writes the string in the application MessagerDriver.
virtual TCollection_ExtendedString	Name () const
	Returns the application name.
virtual TCollection_AsciiString	Version () const
	Returns the application version.
virtual CDM_MetaDataLookUpTable &	MetaDataLookUpTable ()
	Returns MetaData LookUpTable.
void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
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 Member Functions
	CDM_Application ()
void	SetDocumentVersion (const Handle(CDM_Document)&aDocument, const Handle(CDM_MetaData)&aMetaData) const
void	SetReferenceCounter (const Handle(CDM_Document)&aDocument, const Standard_Integer aReferenceCounter)

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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

CDM_Application()

CDM_Application::CDM_Application ( )

protected

Member Function Documentation

BeginOfUpdate()

virtual void CDM_Application::BeginOfUpdate ( const Handle(CDM_Document)& aDocument )

virtual

this method is called before the update of a document. By default, writes in MessageDriver().

DumpJson()

void CDM_Application::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1 ) const

Dumps the content of me into the stream.

EndOfUpdate()

virtual void CDM_Application::EndOfUpdate ( const Handle(CDM_Document)& aDocument, const Standard_Boolean theStatus, const TCollection_ExtendedString & ErrorString )

virtual

this method is called after the update of a document. By default, writes in MessageDriver().

Handle() [1/2]

virtual CDM_Application::Handle ( Message_Messenger )

virtual

Returns default messenger;.

Handle() [2/2]

virtual CDM_Application::Handle ( Resource_Manager )

pure virtual

The manager returned by this virtual method will be used to search for Format.Retrieval resource items.

MetaDataLookUpTable()

virtual CDM_MetaDataLookUpTable & CDM_Application::MetaDataLookUpTable ( )

virtual

Returns MetaData LookUpTable.

Name()

virtual TCollection_ExtendedString CDM_Application::Name ( ) const

virtual

Returns the application name.

SetDocumentVersion()

void CDM_Application::SetDocumentVersion ( const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData ) const

protected

SetReferenceCounter()

void CDM_Application::SetReferenceCounter ( const Handle(CDM_Document)& aDocument, const Standard_Integer aReferenceCounter )

protected

Version()

virtual TCollection_AsciiString CDM_Application::Version ( ) const

virtual

Returns the application version.

Write()

void CDM_Application::Write

(

const Standard_ExtString

aString

)

writes the string in the application MessagerDriver.

---

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

• CDM_Application.hxx