Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Member Functions
CDM_Application Class Referenceabstract

#include <CDM_Application.hxx>

Inheritance diagram for CDM_Application:
Inheritance graph
[legend]

Public Member Functions

virtual Handle< Resource_ManagerResources ()=0
 The manager returned by this virtual method will be used to search for Format.Retrieval resource items. More...
 
virtual Handle< Message_MessengerMessageDriver ()
 Returns default messenger;. More...
 
virtual void BeginOfUpdate (const Handle< CDM_Document > &aDocument)
 this method is called before the update of a document. By default, writes in MessageDriver(). More...
 
virtual void EndOfUpdate (const Handle< CDM_Document > &aDocument, const Standard_Boolean theStatus, const TCollection_ExtendedString &ErrorString)
 this method is called affter the update of a document. By default, writes in MessageDriver(). More...
 
void Write (const Standard_ExtString aString)
 writes the string in the application MessagerDriver. More...
 
virtual TCollection_ExtendedString Name () const
 Returns the application name. More...
 
virtual TCollection_AsciiString Version () const
 Returns the application version. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- 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

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

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

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 affter the update of a document. By default, writes in MessageDriver().

◆ MessageDriver()

virtual Handle< Message_Messenger > CDM_Application::MessageDriver ( )
virtual

Returns default messenger;.

Reimplemented in TDocStd_Application.

◆ Name()

virtual TCollection_ExtendedString CDM_Application::Name ( ) const
virtual

Returns the application name.

◆ Resources()

virtual Handle< Resource_Manager > CDM_Application::Resources ( )
pure virtual

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

Implemented in TDocStd_Application.

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