CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdRxModule Class Referenceabstract

#include <RxModule.h>

Inheritance diagram for OdRxModule:
OdRxObject CFxModule DbPointCloudObjModule ModelerModule OdDAI::OdSDAIModule OdDwfxSignatureHandlerModule OdEdLispModule OdExpSchemaModule OdGsModule OdIfc::OdIfcCoreModule OdIfc::OdIfcGeomModule OdIfcModelerGeometryModule OdPdfImportModule OdPsPlotStyleServices OdRasterProcessingServices OdRxRasterServices OdRxRcsFileServices OdRxThreadPoolService OdTimeProvider SpaModeler

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxModule)
 
virtual voidsysData ()=0
 
virtual void deleteModule ()=0
 
virtual void initApp ()=0
 
virtual void uninitApp ()=0
 
virtual OdString moduleName () 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

<group OdRx_Classes>

This class provides the base implementation of custom Teigha applications (TX modules).

Corresponding C++ library: TD_Db

See also
<link CustomApplications.html, Creating Custom Applications>

OdRxStaticModule, OdRxPseudoStaticModule, OdRxMacModule, OdRxUnixModule, OdRxWin32Module classes

Definition at line 44 of file RxModule.h.

Member Function Documentation

◆ deleteModule()

virtual void OdRxModule::deleteModule ( )
pure virtual

Declares the method deleting (unloading) the rx-module.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.

◆ initApp()

virtual void OdRxModule::initApp ( )
pure virtual

Declares the notification method being called at the start of the client application.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class. Overrides of this module should register any custom objects or commands defined in the module.
See also
<link CustomApplications.html, Creating Custom Applications>

Implemented in OdIfc::OdIfcGeomModule, BaseGLES2Module, SpaModeler, ModelerModule, OdGsBaseModule, DbPointCloudObjModule, OdIfcModelerGeometryModule, and OdIfc::OdIfcCoreModule.

◆ moduleName()

virtual OdString OdRxModule::moduleName ( ) const
pure virtual

Declares the method returning the module name for the rx-module instance.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.

◆ ODRX_DECLARE_MEMBERS()

OdRxModule::ODRX_DECLARE_MEMBERS ( OdRxModule  )

◆ sysData()

virtual void* OdRxModule::sysData ( )
pure virtual

Declares the method returning the system data for the rx-module instance.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.

◆ uninitApp()

virtual void OdRxModule::uninitApp ( )
pure virtual

Declares the notification method being called at the end of the client application.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class. Overrides of this module should unregister any custom objects or commands defined in the module.
See also
<link CustomApplications.html, Creating Custom Applications>

Implemented in OdIfc::OdIfcGeomModule, BaseGLES2Module, SpaModeler, ModelerModule, OdGsBaseModule, DbPointCloudObjModule, OdIfcModelerGeometryModule, and OdIfc::OdIfcCoreModule.


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