OdDbObjectContextInterface Class Reference

#include <DbObjectContextInterface.h>

Inheritance diagram for OdDbObjectContextInterface:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbObjectContextInterface)
virtual bool	supportsCollection (const OdDbObject *pObject, const OdString &collectionName) const =0
virtual bool	hasContext (const OdDbObject *pObject, const OdDbObjectContext &context) const =0
virtual OdResult	addContext (OdDbObject *pObject, const OdDbObjectContext &context) const =0
virtual OdResult	removeContext (OdDbObject *pObject, const OdDbObjectContext &context) const =0
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 is the Protocol Extension class for OdDbObjectContext objects.

Remarks

Implement this interface to use OdDbObjectContext objects, which can determine the properties and behaviors that are available for custom objects.

See also

TD_Db

<group OdDb_Classes>

Definition at line 44 of file DbObjectContextInterface.h.

Member Function Documentation

addContext()

virtual OdResult OdDbObjectContextInterface::addContext ( OdDbObject *  pObject, const OdDbObjectContext &  context  ) const

pure virtual

Adds a context to the specified object.

\param pObject [in]  Pointer to the object.
\param context [in]  Name of the context to add.

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

Implemented in OdDbObjectContextAttributePE, OdDbObjectContextHatchPE, OdDbObjectContextDimPE, OdDbObjectContextBlkRefPE, OdDbObjectContextMLeaderPE, OdDbObjectContextPE, OdDbObjectContextDefaultPE, and OdDbObjectContextPE.

hasContext()

virtual bool OdDbObjectContextInterface::hasContext ( const OdDbObject *  pObject, const OdDbObjectContext &  context  ) const

pure virtual

Returns whether a context is used by a specified object.

\param pObject [in]  Pointer to the object.
\param context [in]  Name of the context.

\returns
Returns true if the object uses the named context, or returns
false if it does not.

Implemented in OdDbObjectContextPE, OdDbObjectContextDefaultPE, and OdDbObjectContextPE.

ODRX_DECLARE_MEMBERS()

OdDbObjectContextInterface::ODRX_DECLARE_MEMBERS

(

OdDbObjectContextInterface

)

removeContext()

virtual OdResult OdDbObjectContextInterface::removeContext ( OdDbObject *  pObject, const OdDbObjectContext &  context  ) const

pure virtual

Removes a context from the specified object.

\param pObject [in]  Pointer to the object.
\param context [in]  Name of the context to remove.

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

Implemented in OdDbObjectContextBlkRefPE, OdDbObjectContextAttributePE, OdDbObjectContextPE, OdDbObjectContextDefaultPE, and OdDbObjectContextPE.

supportsCollection()

virtual bool OdDbObjectContextInterface::supportsCollection ( const OdDbObject *  pObject, const OdString &  collectionName  ) const

pure virtual

Returns whether a context collection is supported by a specified object.

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

\returns
Returns true if the object supports the named context collection, or returns
false if it does not.

Implemented in OdDbObjectContextPE, OdDbObjectContextDefaultPE, and OdDbObjectContextPE.

---

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

• DbObjectContextInterface.h