CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdDbDatabaseReactor Class Reference

#include <DbDatabaseReactor.h>

Inheritance diagram for OdDbDatabaseReactor:
OdRxObject OdStaticRxObject< OdDbDatabaseReactor > CFxDatabaseReactor

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbDatabaseReactor)
 
 OdDbDatabaseReactor ()
 
virtual void objectAppended (const OdDbDatabase *pDb, const OdDbObject *pObject)
 
virtual void objectUnAppended (const OdDbDatabase *pDb, const OdDbObject *pObject)
 
virtual void objectReAppended (const OdDbDatabase *pDb, const OdDbObject *pObject)
 
virtual void objectOpenedForModify (const OdDbDatabase *pDb, const OdDbObject *pObject)
 
virtual void objectModified (const OdDbDatabase *pDb, const OdDbObject *pObject)
 
virtual void objectErased (const OdDbDatabase *pDb, const OdDbObject *pObject, bool erased=true)
 
virtual void headerSysVarWillChange (const OdDbDatabase *pDb, const OdString &name)
 
virtual void headerSysVarChanged (const OdDbDatabase *pDb, const OdString &name)
 
virtual void proxyResurrectionCompleted (const OdDbDatabase *pDb, const OdString &appname, OdDbObjectIdArray &objectIds)
 
virtual void goodbye (const OdDbDatabase *pDb)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the base class for custom classes that receive notification of OdDbDatabase events.

Remarks
Events consist of the addition, modification, or deletion of objects from an OdDbDatabase instance.
The default implementations of all methods in this class do nothing.

<group OdDb_Classes>

Definition at line 48 of file DbDatabaseReactor.h.

Constructor & Destructor Documentation

◆ OdDbDatabaseReactor()

OdDbDatabaseReactor::OdDbDatabaseReactor ( )
inline

Definition at line 53 of file DbDatabaseReactor.h.

Member Function Documentation

◆ goodbye()

virtual void OdDbDatabaseReactor::goodbye ( const OdDbDatabase pDb)
virtual

Notification function called whenever a database is about to be deleted from memory.

Parameters
pDb[in] Pointer to the database being deleted.
Remarks
This function is called before the operation.

◆ headerSysVarChanged()

virtual void OdDbDatabaseReactor::headerSysVarChanged ( const OdDbDatabase pDb,
const OdString name 
)
virtual

Notification function called whenever a database -resident system variable has changed.

Parameters
pDb[in] Pointer to the database being modified.
name[in] Name of the system variable being modified.
Remarks
This function is called after the operation.
See also
<link OdDbDatabaseReactor::headerSysVarWillChange@OdDbDatabase*@OdString&, headerSysVarWillChange() method>

◆ headerSysVarWillChange()

virtual void OdDbDatabaseReactor::headerSysVarWillChange ( const OdDbDatabase pDb,
const OdString name 
)
virtual

Notification function called whenever a database -resident system variable is about to change.

Parameters
pDb[in] Pointer to the database being modified.
name[in] Name of the system variable being modified.
Remarks
This function is called before the operation.
See also
<link OdDbDatabaseReactor::headerSysVarChanged@OdDbDatabase*@OdString&, headerSysVarChanged() method>

◆ objectAppended()

virtual void OdDbDatabaseReactor::objectAppended ( const OdDbDatabase pDb,
const OdDbObject pObject 
)
virtual

Notification function called whenever an OdDbObject has been appended to an OdDbDatabase.

Parameters
pDb[in] Pointer to the database being modified.
pObject[in] Pointer to the object being appended.
Remarks
This function is called after the operation.

◆ objectErased()

virtual void OdDbDatabaseReactor::objectErased ( const OdDbDatabase pDb,
const OdDbObject pObject,
bool  erased = true 
)
virtual

Notification function called whenever an OdDbObject has been erased or unerased.

Parameters
pDb[in] Pointer to the database being modified.
pObject[in] Pointer to the object being modified.
erased[in] True if and only if the object is being erased.
Remarks
This function is called after the operation.

◆ objectModified()

virtual void OdDbDatabaseReactor::objectModified ( const OdDbDatabase pDb,
const OdDbObject pObject 
)
virtual

Notification function called whenever an OdDbObject has been modified.

Parameters
pDb[in] Pointer to the database being modified.
pObject[in] Pointer to the object being modified.
Remarks
This function is called after the operations.
See also
<link OdDbDatabaseReactor::objectOpenedForModify@OdDbDatabase*@OdDbObject*, objectOpenedForModify() method>

◆ objectOpenedForModify()

virtual void OdDbDatabaseReactor::objectOpenedForModify ( const OdDbDatabase pDb,
const OdDbObject pObject 
)
virtual

Notification function called whenever an OdDbObject is about to be modified.

Parameters
pDb[in] Pointer to the database being modified.
pObject[in] Pointer to the object being modified.
Remarks
This function is called before the operations.
See also
<link OdDbDatabaseReactor::objectModified@OdDbDatabase*@OdDbObject*, objectModified() method>

◆ objectReAppended()

virtual void OdDbDatabaseReactor::objectReAppended ( const OdDbDatabase pDb,
const OdDbObject pObject 
)
virtual

Notification function called whenever an OdDbObject has been reappended to an OdDbDatabase by a Redo operation.

Parameters
pDb[in] Pointer to the database being modified.
pObject[in] Pointer to the object being reappended.
Remarks
This function is called after the operation.

◆ objectUnAppended()

virtual void OdDbDatabaseReactor::objectUnAppended ( const OdDbDatabase pDb,
const OdDbObject pObject 
)
virtual

Notification function called whenever an OdDbObject has been unappended from an OdDbDatabase by an Undo operation.

Parameters
pDb[in] Pointer to the database being modified.
pObject[in] Pointer to the object being unappended.
Remarks
This function is called after the operation.

◆ ODRX_DECLARE_MEMBERS()

OdDbDatabaseReactor::ODRX_DECLARE_MEMBERS ( OdDbDatabaseReactor  )

◆ proxyResurrectionCompleted()

virtual void OdDbDatabaseReactor::proxyResurrectionCompleted ( const OdDbDatabase pDb,
const OdString appname,
OdDbObjectIdArray objectIds 
)
virtual

Notification function called after the specified application is loaded and all its proxy objects are resurrected.

Parameters
pDb[in] Pointer to the database being modified.
appname[in] Name of the resurrecting application.
objectIds[in] Object IDs of the resurrected objects.

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