CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | Friends | List of all members
OdApLongTransactionReactor Class Reference

#include <ApLongTransactions.h>

Inheritance diagram for OdApLongTransactionReactor:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdApLongTransactionReactor)
 
 OdApLongTransactionReactor ()
 
virtual void beginCheckOut (OdDbLongTransaction &, OdDbObjectIdArray &originList)
 
virtual void endCheckOut (OdDbLongTransaction &)
 
virtual void beginCheckIn (OdDbLongTransaction &)
 
virtual void endCheckIn (OdDbLongTransaction &)
 
virtual void abortLongTransaction (OdDbLongTransaction &)
 
- 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
 

Protected Member Functions

OdResult veto ()
 

Friends

class OdApLongTransactionManagerImpl
 

Additional Inherited Members

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

Detailed Description

This class is used to access callbacks for long transactions.

See also
TD_Db
<group OdAp_Classes>

Definition at line 44 of file ApLongTransactions.h.

Constructor & Destructor Documentation

◆ OdApLongTransactionReactor()

OdApLongTransactionReactor::OdApLongTransactionReactor ( )

Member Function Documentation

◆ abortLongTransaction()

virtual void OdApLongTransactionReactor::abortLongTransaction ( OdDbLongTransaction )
virtual

Terminates the check out process and returns the aborted long transaction.

◆ beginCheckIn()

virtual void OdApLongTransactionReactor::beginCheckIn ( OdDbLongTransaction )
virtual

Begins the checkin process of the specified long transaction.

◆ beginCheckOut()

virtual void OdApLongTransactionReactor::beginCheckOut ( OdDbLongTransaction ,
OdDbObjectIdArray originList 
)
virtual

Begins the checkout process of the specified long transaction.

\param originList [in]  List/array of objects (in the same block table record) to check out.

◆ endCheckIn()

virtual void OdApLongTransactionReactor::endCheckIn ( OdDbLongTransaction )
virtual

Completes the checkin process of the specified long transaction.

◆ endCheckOut()

virtual void OdApLongTransactionReactor::endCheckOut ( OdDbLongTransaction )
virtual

Completes the checkout process and returns the long transaction.

◆ ODRX_DECLARE_MEMBERS()

OdApLongTransactionReactor::ODRX_DECLARE_MEMBERS ( OdApLongTransactionReactor  )

◆ veto()

OdResult OdApLongTransactionReactor::veto ( )
protected

Terminates the check out process, if in progress.

Friends And Related Function Documentation

◆ OdApLongTransactionManagerImpl

friend class OdApLongTransactionManagerImpl
friend

Definition at line 81 of file ApLongTransactions.h.


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