OdApLongTransactionManager Class Reference

#include <ApLongTransactions.h>

Inheritance diagram for OdApLongTransactionManager:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdApLongTransactionManager)
virtual OdResult	checkOut (OdDbObjectId &transId, OdDbObjectIdArray &objList, OdDbObjectId toBlock, OdDbIdMapping &errorMap, OdDbObjectId lockBlkRef=OdDbObjectId::kNull)=0
virtual OdResult	checkIn (OdDbObjectId transId, OdDbIdMapping &errorMap, bool keepObjs=false)=0
virtual OdResult	abortLongTransaction (OdDbObjectId transId, bool keepObjs=false)=0
virtual OdDbObjectId	currentLongTransactionFor (const OdDbDatabase *pDb) const =0
virtual void	addReactor (OdApLongTransactionReactor *)=0
virtual void	removeReactor (OdApLongTransactionReactor *)=0
virtual OdResult	addClassFilter (OdRxClass *)=0
virtual bool	isFiltered (OdRxClass *) const =0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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 OdRxClass *	desc ()

Detailed Description

This class controls long transactions.

Remarks

There is one OdApLongTransactionManager object per application session.

See also

TD_Db

<group OdAp_Classes> 

Definition at line 95 of file ApLongTransactions.h.

Member Function Documentation

abortLongTransaction()

virtual OdResult OdApLongTransactionManager::abortLongTransaction ( OdDbObjectId  transId, bool  keepObjs = false  )

pure virtual

Terminates a long transaction during or in between checkin and checkout.

Parameters

transID	[in] Object ID of the long transaction.
keepObjs	[in] Boolean value indicating whether to keep cloned objects.

addClassFilter()

virtual OdResult OdApLongTransactionManager::addClassFilter ( OdRxClass *  )

pure virtual

Adds the class of the specified OdRxClass object to the class filter.

addReactor()

virtual void OdApLongTransactionManager::addReactor ( OdApLongTransactionReactor *  )

pure virtual

Adds the specified reactor to this object's reactor list.

checkIn()

virtual OdResult OdApLongTransactionManager::checkIn ( OdDbObjectId  transId, OdDbIdMapping &  errorMap, bool  keepObjs = false  )

pure virtual

Checks in a long transaction that was previously checked out.

Parameters

transID	[in] Object ID of the long transaction.
errorMap	[out] Receives an empty mapping object.
keepObjs	[in] Boolean value indicating whether to keep workset objects.

checkOut()

virtual OdResult OdApLongTransactionManager::checkOut ( OdDbObjectId &  transId, OdDbObjectIdArray &  objList, OdDbObjectId  toBlock, OdDbIdMapping &  errorMap, OdDbObjectId  lockBlkRef = OdDbObjectId::kNull  )

pure virtual

Generates a new long transaction and clones objects from the specified list.

Parameters

transID	[out] Receives the object ID of the new long transaction.
objList	[in] List/array of objects (in the same block table record) to check out.
toBlock	[in] Object ID of the block table record to which the objects will be cloned.
errorMap	[out] Receives an empty mapping object.
lockBlkRef	[in] Optional object ID of the last block reference, which during checkout will will be placed on a locked layer.

currentLongTransactionFor()

virtual OdDbObjectId OdApLongTransactionManager::currentLongTransactionFor ( const OdDbDatabase *  pDb ) const

pure virtual

isFiltered()

virtual bool OdApLongTransactionManager::isFiltered ( OdRxClass *  ) const

pure virtual

Returns True if the class of the specified OdRxClass object is in the class filter.

ODRX_DECLARE_MEMBERS()

OdApLongTransactionManager::ODRX_DECLARE_MEMBERS

(

OdApLongTransactionManager

)

removeReactor()

virtual void OdApLongTransactionManager::removeReactor ( OdApLongTransactionReactor *  )

pure virtual

Deletes the specified reactor from this object's reactor list.

---

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

• ApLongTransactions.h