DbLongTransaction.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef ODDBLONGTRANSWORKSETITERATOR_INCLUDED
#define ODDBLONGTRANSWORKSETITERATOR_INCLUDED
 
#include "DbObject.h"
#include "DwgDeclareMembers.h"

class ODRX_ABSTRACT TOOLKIT_EXPORT OdDbLongTransWorkSetIterator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbLongTransWorkSetIterator);
  
    virtual void start(
    bool incRemovedObjs = false, 
    bool incSecondaryObjs = false) = 0; 
  
    virtual bool done() = 0;

    virtual void step() = 0;
  
    virtual OdDbObjectId objectId() const = 0;
  
    virtual bool curObjectIsErased() const = 0;

    virtual bool curObjectIsRemoved() const = 0;

    virtual bool curObjectIsPrimary() const = 0;
};

typedef OdSmartPtr<OdDbLongTransWorkSetIterator> OdDbLongTransWorkSetIteratorPtr;

class TOOLKIT_EXPORT OdDbLongTransaction : public OdDbObject
{
public:
  DWGMAP_DECLARE_MEMBERS(OdDbLongTransaction);
 
  OdDbLongTransaction();
  
  enum
  {
    kSameDb        = 0, // Entities are checked out from a normal block 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*.
  };
  
  int type() const;
  
  OdDbObjectId originBlock() const;

  OdDbObjectId destinationBlock() const;
  
  
  OdString getLongTransactionName() const;
  
  OdResult addToWorkSet(OdDbObjectId ObjectId);

  OdResult fadeExclusion(OdDbObjectId ObjectId);

  OdResult removeFromWorkSet(OdDbObjectId id);
  
  OdResult syncWorkSet();
  
  OdDbLongTransWorkSetIteratorPtr newWorkSetIterator(
    bool incRemovedObjs = false, 
    bool incSecondaryObjs = false) const;
  
  OdDbObjectId originObject(
    OdDbObjectId workSetId) const;

  bool workSetHas(OdDbObjectId 
    ObjectId, 
    bool getErased = false) const;

  bool needsFading(OdDbObjectId
    ObjectId) const;
  
  OdDbIdMapping* activeIdMap();
 
  void applyPartialUndo(OdDbDwgFiler* pUndoFiler, OdRxClass* pClassObj);
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler);
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const;
  virtual OdResult subErase(bool erasing);
};
 
typedef OdSmartPtr<OdDbLongTransaction> OdDbLongTransactionPtr;
 
#endif // ODDBLONGTRANSWORKSETITERATOR_INCLUDED