CFx SDK Documentation  2020SP3
Public Member Functions | Protected Attributes | List of all members
OdDbObjectContextManager Class Reference

#include <DbObjectContextManager.h>

Inheritance diagram for OdDbObjectContextManager:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbObjectContextManager)
 
 OdDbObjectContextManager (OdDbObjectContextManagerImpl *)
 
virtual ~OdDbObjectContextManager ()
 
OdResult registerContextCollection (const OdString &collectionName, OdDbObjectContextCollection *pCollection)
 
OdResult unregisterContextCollection (const OdString &collectionName)
 
OdDbObjectContextCollectioncontextCollection (const OdString &collectionName) const
 
- 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
 

Protected Attributes

OdDbObjectContextManagerImpl * m_pImpl
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class returns and manages the context objects that are available in a drawing.

See also
TD_Db

<group OdDb_Classes>

Definition at line 46 of file DbObjectContextManager.h.

Constructor & Destructor Documentation

◆ OdDbObjectContextManager()

OdDbObjectContextManager::OdDbObjectContextManager ( OdDbObjectContextManagerImpl *  )

◆ ~OdDbObjectContextManager()

virtual OdDbObjectContextManager::~OdDbObjectContextManager ( )
virtual

Member Function Documentation

◆ contextCollection()

OdDbObjectContextCollection* OdDbObjectContextManager::contextCollection ( const OdString collectionName) const

Returns a pointer to a context collection using its name as an identifier.

\param collectionName [out]  Name of the context collection.

\returns
Returns a pointer to the registered context collection. 
If no collection exists     with the specified name, Null is returned.

◆ ODRX_DECLARE_MEMBERS()

OdDbObjectContextManager::ODRX_DECLARE_MEMBERS ( OdDbObjectContextManager  )

◆ registerContextCollection()

OdResult OdDbObjectContextManager::registerContextCollection ( const OdString collectionName,
OdDbObjectContextCollection pCollection 
)

Registers a context collection with the context manager.

\param collectionName [in]  Name of the context collection.
\param pCollection [in]  Pointer to the context collection.

\returns
Returns eOk if successful, or an appropriate error code if not.

◆ unregisterContextCollection()

OdResult OdDbObjectContextManager::unregisterContextCollection ( const OdString collectionName)

Unregisters a context collection from the context manager.

\param collectionName [in]  Name of the context collection.

\returns
Returns eOk if successful, or an appropriate error code if not.

Member Data Documentation

◆ m_pImpl

OdDbObjectContextManagerImpl* OdDbObjectContextManager::m_pImpl
protected

Definition at line 92 of file DbObjectContextManager.h.


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