OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    CDM_Application Class Referenceabstract

    #include <CDM_Application.hxx>

    Inheritance diagram for CDM_Application:
    Inheritance graph
    [legend]

    Public Member Functions

    virtual occ::handle< Resource_Manager > Resources ()=0
     The manager returned by this virtual method will be used to search for Format.Retrieval resource items.
    virtual occ::handle< Message_Messenger > MessageDriver ()
     Returns default messenger;.
    virtual void BeginOfUpdate (const occ::handle< CDM_Document > &aDocument)
     this method is called before the update of a document. By default, writes in MessageDriver().
    virtual void EndOfUpdate (const occ::handle< CDM_Document > &aDocument, const bool theStatus, const TCollection_ExtendedString &ErrorString)
     this method is called after the update of a document. By default, writes in MessageDriver().
    void Write (const char16_t *const 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 NCollection_DataMap< TCollection_ExtendedString, occ::handle< CDM_MetaData > > & MetaDataLookUpTable ()
     Returns MetaData LookUpTable.
    void DumpJson (Standard_OStream &theOStream, int 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 ()=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

     CDM_Application ()
    void SetDocumentVersion (const occ::handle< CDM_Document > &aDocument, const occ::handle< CDM_MetaData > &aMetaData) const
    void SetReferenceCounter (const occ::handle< CDM_Document > &aDocument, const int 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 occ::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,
    int theDepth = -1 ) const

    Dumps the content of me into the stream.

    ◆ EndOfUpdate()

    virtual void CDM_Application::EndOfUpdate ( const occ::handle< CDM_Document > & aDocument,
    const bool theStatus,
    const TCollection_ExtendedString & ErrorString )
    		virtual

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

    ◆ MessageDriver()

    virtual occ::handle< Message_Messenger > CDM_Application::MessageDriver ( )
    		virtual

    Returns default messenger;.

    ◆ MetaDataLookUpTable()

    virtual NCollection_DataMap< TCollection_ExtendedString, occ::handle< CDM_MetaData > > & CDM_Application::MetaDataLookUpTable ( )
    		virtual

    Returns MetaData LookUpTable.

    ◆ Name()

    virtual TCollection_ExtendedString CDM_Application::Name ( ) const
    		virtual

    Returns the application name.

    ◆ Resources()

    virtual occ::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 occ::handle< CDM_Document > & aDocument,
    const occ::handle< CDM_MetaData > & aMetaData ) const
    		protected

    ◆ SetReferenceCounter()

    void CDM_Application::SetReferenceCounter ( const occ::handle< CDM_Document > & aDocument,
    const int aReferenceCounter )
    		protected

    ◆ Version()

    virtual TCollection_AsciiString CDM_Application::Version ( ) const
    		virtual

    Returns the application version.

    ◆ Write()

    void CDM_Application::Write ( const char16_t *const aString)

    writes the string in the application MessagerDriver.

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