CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | List of all members
OdRxModuleSoftReference< TModule > Class Template Reference

#include <RxModuleSoftReference.h>

Inheritance diagram for OdRxModuleSoftReference< TModule >:
OdStaticRxObject< OdRxDLinkerReactor > OdRxDLinkerReactor OdRxObject

Public Member Functions

 OdRxModuleSoftReference ()
 
 ~OdRxModuleSoftReference ()
 
OdSmartPtr< TModule > getModule (const OdString &appName)
 
TModule * getRef ()
 
void clear ()
 

Protected Member Functions

void rxAppWillBeUnloaded (OdRxModule *pModule)
 
- Protected Member Functions inherited from OdStaticRxObject< OdRxDLinkerReactor >
void addRef ()
 
void release ()
 
- Protected Member Functions inherited from OdRxDLinkerReactor
 ODRX_DECLARE_MEMBERS (OdRxDLinkerReactor)
 
virtual void rxAppWillBeLoaded (const OdString &moduleName)
 
virtual void rxAppLoaded (OdRxModule *pModule)
 
virtual void rxAppLoadAborted (const OdString &moduleName)
 
virtual void rxAppUnloaded (const OdString &moduleName)
 
virtual void rxAppUnloadAborted (OdRxModule *pModule)
 
- Protected 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 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
 

Detailed Description

template<class TModule = OdRxModule>
class OdRxModuleSoftReference< TModule >

<group OdRx_Classes>

This template class represents client's atomic portion of code to execute via asynchronous call.

Corresponding C++ library: TD_Db

See also
OdRxModule, OdRxDLinkerReactor classes

Definition at line 46 of file RxModuleSoftReference.h.

Constructor & Destructor Documentation

◆ OdRxModuleSoftReference()

template<class TModule = OdRxModule>
OdRxModuleSoftReference< TModule >::OdRxModuleSoftReference ( )
inline

Builds an instance of this object.

Definition at line 59 of file RxModuleSoftReference.h.

◆ ~OdRxModuleSoftReference()

template<class TModule = OdRxModule>
OdRxModuleSoftReference< TModule >::~OdRxModuleSoftReference ( )
inline

Destroy an instance of this object.

Definition at line 64 of file RxModuleSoftReference.h.

Member Function Documentation

◆ clear()

template<class TModule = OdRxModule>
void OdRxModuleSoftReference< TModule >::clear ( )
inline

Unload this module.

Definition at line 91 of file RxModuleSoftReference.h.

◆ getModule()

template<class TModule = OdRxModule>
OdSmartPtr<TModule> OdRxModuleSoftReference< TModule >::getModule ( const OdString appName)
inline

Returns a smart pointer to the rx-module instance with the specified name.

Parameters
appName[in] Name as a non-empty string value.

Definition at line 71 of file RxModuleSoftReference.h.

◆ getRef()

template<class TModule = OdRxModule>
TModule* OdRxModuleSoftReference< TModule >::getRef ( )
inline

Returns a raw pointer to the rx-module instance.

Definition at line 84 of file RxModuleSoftReference.h.

◆ rxAppWillBeUnloaded()

template<class TModule = OdRxModule>
void OdRxModuleSoftReference< TModule >::rxAppWillBeUnloaded ( OdRxModule pModule)
inlineprotectedvirtual

DOM

Reimplemented from OdRxDLinkerReactor.

Definition at line 50 of file RxModuleSoftReference.h.


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