#include <DbPageController.h>
Public Types | |
| typedef OdInt64 | Key |
Public Member Functions | |
| 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) |
 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 the paging support for an OdDbDatabase instance.
- See also
- Paging Support OdDbDatabase::pageObjects
<group OdDb_Classes>
Definition at line 90 of file DbPageController.h.
Member Typedef Documentation
◆ Key
| typedef OdInt64 OdDbPageController::Key |
Definition at line 93 of file DbPageController.h.
Member Function Documentation
◆ database()
|
pure virtual |
Returns the OdDbDatabase instance served by this controller.
◆ pagingType()
|
pure virtual |
Returns the paging type for this PageController object.
- Remarks
- pagingType() returns a combination of zero or more of the following:
Value Description OdDb::kUnload 0x01 Enable unloading for objects in a partially opened OdDbDatabase instance.
OdDb::kPage 0x02 Enable paging for objects in an OdDbDatabase instance. OdDb::kDoNotEnqueuePagingOnClose 0x04 Disable automated object paging enqueuing in OdDbObject::release.
- See also
- <link tdrawings_paging, Paging Support>
◆ read()
|
pure virtual |
Pages in the specified data.
- Remarks
- Returns a SmartPointer to an OdDbStreamBuf object containing the specified paged data from a client-supplied data source.
- Parameters
-
key [in] Paged data key, as returned by write().
◆ setDatabase()
|
pure virtual |
Sets the OdDbDatabase instance served by this controller.
- Parameters
-
pDb [in] Pointer to the database.
- Remarks
- The method is called by the Drawings during initialization of database paging.
◆ subPage()
|
virtual |
The method is called during unloading/paging of an object, before anything else is done.
- Parameters
-
objectId [in] Object ID.
- Remarks
- subPage() returns one of the of the following:
Description eOk Continue paging. eSkipObjPaging Skip paging of the specified object. eStopPaging Stop paging.
- Remarks
- The default implementation does nothing but return eOk. This function can be overridden in custom classes.
◆ write()
|
pure virtual |
Pages out data as required to a client-supplied data source.
- Parameters
-
key [out] Paged data key, as used by read(). pStreamBuf [in] Pointer to the StreamBuf object from which the data are to be written.
- Returns
- Returns true if and only if the PageController implementation has successfully paged the data.
- Remarks
- Implementations of this function are expected to write the entire contents of pStreamBuf to an external data source, and to set assign a unique value to the key argument that identifies this chunk of paged data. This key value will be used in a subsequent calls to read() to retrieve this specific paged data.
The documentation for this class was generated from the following file: