#include <DbLongTransaction.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Member Functions inherited from OdDbObject | |
| OdDbObject () | |
| virtual OdResult | subGetClassID (void *pClsid) const |
| virtual OdDbObjectPtr | subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| virtual OdDbObjectPtr | subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class implements the tracking of long transactions.
- Remarks
- This class creates and appends OdcDbLongTransaction objects to the database and and returns the object ID of the OdDbLongTransaction object. Destruction of the OdDbLongTransaction object is handled by the database.
<group OdDb_Classes>
Definition at line 115 of file DbLongTransaction.h.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| kSameDb | |
| kXrefDb | |
| kUnrelatedDb | |
Definition at line 122 of file DbLongTransaction.h.
Constructor & Destructor Documentation
◆ OdDbLongTransaction()
| OdDbLongTransaction::OdDbLongTransaction | ( | ) |
Member Function Documentation
◆ activeIdMap()
| OdDbIdMapping* OdDbLongTransaction::activeIdMap | ( | ) |
Returns a pointer to the OdDbMapping object used for OdLongTransationReactor callbacks used for checkin/checkout.
◆ addToWorkSet()
| OdResult OdDbLongTransaction::addToWorkSet | ( | OdDbObjectId | ObjectId | ) |
Adds the specified object to the current work set.
- Parameters
-
objectId [in] Object ID to be added.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
objectId must be in the same database as the the transaction.
objectId can specify objects from either the origin block or destination block. Objects from the destination block will be cloned; objects from the origin block will not.
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pUndoFiler [in] A pointer to the undo filer with the partial undo information. pClassObj [in] A pointer to the OdRxClass object for the class that will handle the Undo.
- Remarks
- An object indicates it's using the partial undo mechanism, if and only if it has set autoUndo false in all calls to assertWriteEnabled().
This member function must know which types of fields to scan, and must stop after reading what it it needs.
If the class type specified by pClassObj does not matches the class of this object, this member function must call the parent class's applyPartialUndo() and return whatever it returns.
If it does match the class of this object, this member function must use pUndoFiler to read the undo data, then typically use this object's set() method.
Throws:
Cause eNotThatKindOfClass pClassObj != OdDbObject::desc()
Reimplemented from OdDbObject.
◆ destinationBlock()
| OdDbObjectId OdDbLongTransaction::destinationBlock | ( | ) | const |
Returns the object ID of the block to which the entities are cloned.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
◆ getLongTransactionName()
| OdString OdDbLongTransaction::getLongTransactionName | ( | ) | const |
Returns the long transaction name.
- Returns
- Returns the name of the origin block or layout.
◆ newWorkSetIterator()
| OdDbLongTransWorkSetIteratorPtr OdDbLongTransaction::newWorkSetIterator | ( | bool | incRemovedObjs = false, |
| bool | incSecondaryObjs = false |
||
| ) | const |
Creates an Iterator object that provides access to the entities in the work set.
- Parameters
-
incRemovedObjs [in] True to include removed and erased objects from the work set. incSecondaryObj [in] True to include objects referenced by objects in the work set.
◆ ODDB_DECLARE_MEMBERS()
| OdDbLongTransaction::ODDB_DECLARE_MEMBERS | ( | OdDbLongTransaction | ) |
◆ originBlock()
| OdDbObjectId OdDbLongTransaction::originBlock | ( | ) | const |
Returns the object ID of the block from which the entities are cloned.
◆ originObject()
| OdDbObjectId OdDbLongTransaction::originObject | ( | OdDbObjectId | workSetId | ) | const |
Returns the object ID from which the workSetId was cloned.
- Parameters
-
workSetId [in] Work set object ID..
◆ removeFromWorkSet()
| OdResult OdDbLongTransaction::removeFromWorkSet | ( | OdDbObjectId | id | ) |
Removes the specified object from the current work set.
- Parameters
-
objectId [in] Object ID to be removed.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ syncWorkSet()
| OdResult OdDbLongTransaction::syncWorkSet | ( | ) |
Synchronizes work set.
- Remarks
- removeFromWorkSet() does not remove from the work set objects referenced by removed objects. syncWorkSet() removes them.
◆ type()
| int OdDbLongTransaction::type | ( | ) | const |
Returns the type of the pending long transaction:
- Remarks
- type will return one of the following
Value Description kSameDb 0 Entities are checked out from a normal block or layout in the current database. kXrefDb 1 Entities are checked out from ModelSpace or an Xref dependent block in an Xref database. kUnrelatedDb 2 Entities are checked out from ModelSpace or a block in an unrelated database.
◆ workSetHas()
| bool OdDbLongTransaction::workSetHas | ( | OdDbObjectId | ObjectId, |
| bool | getErased = false |
||
| ) | const |
Returns true if and only if the specified object ID is in the work set.
- Parameters
-
objectId [in] Object ID being tested. getErased [in] True to return true for erased and removed objects in the work set.
The documentation for this class was generated from the following file: