CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbTransactionReactor Class Reference

#include <DbTransactionReactor.h>

Inheritance diagram for OdDbTransactionReactor:
OdRxObject OdStaticRxObject< OdDbTransactionReactor > OdDbSafeTransaction

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbTransactionReactor)
 
 OdDbTransactionReactor ()
 
virtual void transactionAboutToStart (OdDbDatabase *pDb)
 
virtual void transactionStarted (OdDbDatabase *pDb)
 
virtual void transactionAboutToEnd (OdDbDatabase *pDb)
 
virtual void transactionEnded (OdDbDatabase *pDb)
 
virtual void transactionAboutToAbort (OdDbDatabase *pDb)
 
virtual void transactionAborted (OdDbDatabase *pDb)
 
virtual void endCalledOnOutermostTransaction (OdDbDatabase *pDb)
 
virtual void objectIdSwapped (const OdDbObject *pTransObj, const OdDbObject *pOtherTransObj, 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 OdDbTransaction events.

Remarks
The default implementations of all methods in this class do nothing but return.
See also
TD_Db

<group OdDb_Classes>

Definition at line 49 of file DbTransactionReactor.h.

Constructor & Destructor Documentation

◆ OdDbTransactionReactor()

OdDbTransactionReactor::OdDbTransactionReactor ( )
inline

Definition at line 54 of file DbTransactionReactor.h.

Member Function Documentation

◆ endCalledOnOutermostTransaction()

virtual void OdDbTransactionReactor::endCalledOnOutermostTransaction ( OdDbDatabase pDb)
virtual

Notification function called to indicate the outermost transaction has ended.

Parameters
pDb[in] Pointer to the database sending the notification.

◆ objectIdSwapped()

virtual void OdDbTransactionReactor::objectIdSwapped ( const OdDbObject pTransObj,
const OdDbObject pOtherTransObj,
OdDbDatabase pDb 
)
virtual

Notification function called when the transaction resident object is involved in a swapIdWith() operation.

Parameters
pTransObj[in] Pointer to the first transaction resident object.
pOtherTransObj[in] Pointer to the second transaction resident object.
pDb[in] Pointer to the database sending the notification.
Remarks
According to database transactions implementation the both objects are transaction-resident or not. So this function will be called only once in OdDbObject::swapIdWith() method.

◆ ODRX_DECLARE_MEMBERS()

OdDbTransactionReactor::ODRX_DECLARE_MEMBERS ( OdDbTransactionReactor  )

◆ transactionAborted()

virtual void OdDbTransactionReactor::transactionAborted ( OdDbDatabase pDb)
virtual

Notification function called to indicate a transaction has been terminated.

Parameters
pDb[in] Pointer to the database sending the notification.
See also
transactionAboutToAbort transactionAboutToEnd transactionAboutToStart transactionEnded transactionStarted

◆ transactionAboutToAbort()

virtual void OdDbTransactionReactor::transactionAboutToAbort ( OdDbDatabase pDb)
virtual

Notification function called to indicate a transaction is about to be terminated.

Parameters
pDb[in] Pointer to the database sending the notification.
See also
transactionAborted transactionAboutToEnd transactionAboutToStart transactionEnded transactionStarted

◆ transactionAboutToEnd()

virtual void OdDbTransactionReactor::transactionAboutToEnd ( OdDbDatabase pDb)
virtual

Notification function called to indicate a transaction is about to end.

Parameters
pDb[in] Pointer to the database sending the notification.
See also
transactionAborted transactionAboutToAbort transactionAboutToStart transactionEnded transactionStarted

◆ transactionAboutToStart()

virtual void OdDbTransactionReactor::transactionAboutToStart ( OdDbDatabase pDb)
virtual

Notification function called to indicate a new transaction is about to start.

Parameters
pDb[in] Pointer to the database sending the notification.
See also
transactionAborted transactionAboutToAbort transactionAboutToEnd transactionEnded transactionStarted

◆ transactionEnded()

virtual void OdDbTransactionReactor::transactionEnded ( OdDbDatabase pDb)
virtual

Notification function called to indicate a transaction has ended.

Parameters
pDb[in] Pointer to the database sending the notification.
See also
transactionAborted transactionAboutToAbort transactionAboutToEnd transactionAboutToStart transactionStarted

◆ transactionStarted()

virtual void OdDbTransactionReactor::transactionStarted ( OdDbDatabase pDb)
virtual

Notification function called to indicate a new transaction has started.

Parameters
pDb[in] Pointer to the database sending the notification.
See also
transactionAborted transactionAboutToAbort transactionAboutToEnd transactionAboutToStart transactionEnded

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