CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbObjectContext Class Referenceabstract

#include <DbObjectContext.h>

Inheritance diagram for OdDbObjectContext:
OdRxObject OdDbAnnotationScale OdDbAnnotationScaleView

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbObjectContext)
 
virtual ~OdDbObjectContext ()
 
virtual OdString getName () const =0
 
virtual OdResult setName (const OdString &name)=0
 
virtual OdIntPtr uniqueIdentifier () const =0
 
virtual OdString collectionName () const =0
 
- 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
 

Additional Inherited Members

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

Detailed Description

This class represents a context that can determine what properties and behaviors are available for custom objects.

Remarks
An annotation scale is an example of an object that has a context that determines its available options and behavior.
See also
TD_Db

<group OdDb_Classes>

Definition at line 48 of file DbObjectContext.h.

Constructor & Destructor Documentation

◆ ~OdDbObjectContext()

virtual OdDbObjectContext::~OdDbObjectContext ( )
virtual

Member Function Documentation

◆ collectionName()

virtual OdString OdDbObjectContext::collectionName ( ) const
pure virtual

Returns the name of the context collection to which the context belongs.

Implemented in OdDbAnnotationScaleView, and OdDbAnnotationScale.

◆ getName()

virtual OdString OdDbObjectContext::getName ( ) const
pure virtual

Returns the name of the context.

\remarks
When referencing a context, do not use the context name since it can change.
Use the context ID instead.

Implemented in OdDbAnnotationScale.

◆ ODRX_DECLARE_MEMBERS()

OdDbObjectContext::ODRX_DECLARE_MEMBERS ( OdDbObjectContext  )

◆ setName()

virtual OdResult OdDbObjectContext::setName ( const OdString name)
pure virtual

Sets a new name of a context.

\param name [in]  New name of the context.

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

Implemented in OdDbAnnotationScale.

◆ uniqueIdentifier()

virtual OdIntPtr OdDbObjectContext::uniqueIdentifier ( ) const
pure virtual

Returns the ID of the context.

\remarks
Use the context ID when referencing a context since it is unique. Do not use 
the context name since it can change.       

Implemented in OdDbAnnotationScale.


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