CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdDbBaseLongTransactionPE Class Referenceabstract

#include <DbBaseDatabase.h>

Inheritance diagram for OdDbBaseLongTransactionPE:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbBaseLongTransactionPE)
 
virtual OdDbStub * destinationBlock (const OdRxObject *pLT) const =0
 
virtual OdDbBaseDatabasegetDatabase (const OdRxObject *pLT) const =0
 
virtual bool workSetHas (const OdRxObject *pLT, OdDbStub *pId) const =0
 
virtual OdRxIteratorPtr newWorkSetIterator (const OdRxObject *pLT, bool incRemoved=false, bool incSecondary=false) const =0
 
- 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 protocol extension to be used as a long transaction abstraction, independent of the underlying database (OdDbDatabase or OdDgDatabase).

See also
TD_DbRoot

<group OdDbRoot_Classes>

Definition at line 1071 of file DbBaseDatabase.h.

Member Function Documentation

◆ destinationBlock()

virtual OdDbStub* OdDbBaseLongTransactionPE::destinationBlock ( const OdRxObject pLT) const
pure virtual

Returns a pointer to the identifier of a block where entities have been copied.

Parameters
pLT[in] A pointer to a long transaction object.

◆ getDatabase()

virtual OdDbBaseDatabase* OdDbBaseLongTransactionPE::getDatabase ( const OdRxObject pLT) const
pure virtual

Returns a pointer to the database, to which a specified long transaction object belongs.

Parameters
pLT[in] A pointer to a long transaction object.

◆ newWorkSetIterator()

virtual OdRxIteratorPtr OdDbBaseLongTransactionPE::newWorkSetIterator ( const OdRxObject pLT,
bool  incRemoved = false,
bool  incSecondary = false 
) const
pure virtual

Creates an iterator for a specified long transaction workset.

Parameters
pLT[in] A pointer to a long transaction object.
incRemoved[in] A flag that determines whether the iterator includes removed objects (if equal to true).
incSecondary[in] A flag that determines whether the iterator includes secondary objects (if equal to true).

◆ ODRX_DECLARE_MEMBERS()

OdDbBaseLongTransactionPE::ODRX_DECLARE_MEMBERS ( OdDbBaseLongTransactionPE  )

◆ workSetHas()

virtual bool OdDbBaseLongTransactionPE::workSetHas ( const OdRxObject pLT,
OdDbStub *  pId 
) const
pure virtual

Determines whether a specified long transaction object contains a specified object in its workset.

Parameters
pLT[in] A pointer to a long transaction object.
pId[in] A pointer to an identifier of an object.
Returns
Returns true if the long transaction workset contains the object specified with the identifier pId parameter. Otherwise returns false.

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