DbPageController.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 _ODDBPAGECONTROLLER_INCLUDED_
#define _ODDBPAGECONTROLLER_INCLUDED_
 
#include "RxObject.h"
#include "DbExport.h"
#include "DbDatabase.h"
 
class OdDbDatabase;
class OdDbObjectId;
class OdStreamBuf;
typedef OdSmartPtr<OdStreamBuf> OdStreamBufPtr;
 
namespace OdDb
{
  enum PagingType
  {
    kUnload  = 0x01,  
    kPage    = 0x02,
    kDoNotEnqueuePagingOnClose = 0x04   
  };
}
 
class TOOLKIT_EXPORT OdDbPageController : public OdRxObject
{
public:
  typedef OdInt64 Key;
 
  virtual int pagingType() const = 0;
 
  virtual OdStreamBufPtr read(Key key) = 0;
 
  virtual bool write(Key& key, OdStreamBuf* pStreamBuf) = 0;
 
  virtual void setDatabase(OdDbDatabase* pDb) = 0;
 
  virtual OdDbDatabase* database() = 0;
 
  virtual OdResult subPage(const OdDbObjectId& objectId);
};
 
typedef OdSmartPtr<OdDbPageController> OdDbPageControllerPtr;
 
inline void odDbPageObjects(OdDbDatabase* pDb) {
  pDb->pageObjects();
}
 
#endif // _ODDBPAGECONTROLLER_INCLUDED_