CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbCommandContext Class Reference

#include <DbCommandContext.h>

Inheritance diagram for OdDbCommandContext:
OdEdCommandContext OdRxObject CFxCommandContext

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbCommandContext)
 
virtual OdDbDatabase * database ()
 
OdDbUserIO * dbUserIO ()
 
- Public Member Functions inherited from OdEdCommandContext
 ODRX_DECLARE_MEMBERS (OdEdCommandContext)
 
virtual OdEdUserIO * userIO ()=0
 
virtual OdEdFunctionIO * funcIO ()=0
 
virtual OdRxObject * baseDatabase ()=0
 
virtual void setArbitraryData (const OdString &szPathName, OdRxObject *pDataObj)=0
 
virtual OdRxObjectPtr arbitraryData (const OdString &szPathName) const =0
 
virtual void reset (class OdEdBaseIO *, OdRxObject *)
 
virtual OdEdBaseIO * baseIO ()
 
virtual OdSmartPtr< OdEdCommandContext > cloneObject (OdEdBaseIO *=NULL, OdRxObject *=NULL)
 
- 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 defines the interface for I/O and database access for custom commands during their execution.

Remarks
Client applications that invoke custom commands, should use an instance of this class (or a subclass) to pass to the OdEdCommandStack::executeCommand function. Using this class instead of a true instance of OdEdCommandContext provides custom commands with database access.

<group OdDb_Classes>

Definition at line 54 of file DbCommandContext.h.

Member Function Documentation

◆ database()

OdDbDatabase * OdDbCommandContext::database ( )
inlinevirtual

Returns a database, for use in a custom command.

Reimplemented in CFxCommandContext.

Definition at line 77 of file DbCommandContext.h.

◆ dbUserIO()

OdDbUserIO * OdDbCommandContext::dbUserIO ( )
inline

Definition at line 70 of file DbCommandContext.h.

◆ ODRX_DECLARE_MEMBERS()

OdDbCommandContext::ODRX_DECLARE_MEMBERS ( OdDbCommandContext  )

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