CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdBaseObjectPtr Class Reference

#include <BaseObjectPtr.h>

Inheritance diagram for OdBaseObjectPtr:
OdSmartPtr< OdGsCullingVolume > OdSmartPtr< OdGiSectionGeometryOutput > OdSmartPtr< OdGsBaseModel > OdSmartPtr< OdGsExtAccum > OdSmartPtr< OdGiRasterImage > OdSmartPtr< OdGiModelToViewProc > OdSmartPtr< Schema > OdSmartPtr< OdBcfHeader > OdSmartPtr< OdBcfTimeStamp > OdSmartPtr< OdBcfVersion > OdSmartPtr< OdDbObject > OdSmartPtr< OdGsFiler_SubstitutorImpl > OdSmartPtr< OdFont > OdSmartPtr< OdGiLinetypeRedir > OdSmartPtr< OdPwdCache > OdSmartPtr< OdBcfExceptions > OdSmartPtr< OdBcfPoint > OdSmartPtr< OdEdCommand > OdSmartPtr< OdGsFilerDbLinker > OdSmartPtr< OdGiTransientManager > OdSmartPtr< OdGiMaterialItem > OdSmartPtr< OdDbPlotSettingsValidator > OdSmartPtr< ModelContents > OdSmartPtr< OdTrVisTexture > OdSmartPtr< OdGsBaseModule > OdSmartPtr< OdPsPlotStyleTable > OdSmartPtr< OdTrVectorizerPropertyResolver > OdSmartPtr< OdRxDictionaryIterator > OdSmartPtr< OdGiFill > OdSmartPtr< OdBcfDataAccessor > OdSmartPtr< OdBcfGUIDAttribute > OdSmartPtr< OdGiDrawable > OdSmartPtr< OdGsBackground > OdSmartPtr< VpData > OdSmartPtr< OdGiContext > OdSmartPtr< OdGiMaterialTexture > OdSmartPtr< OdBcfClippingPlanes > OdSmartPtr< OdBcfComponents > OdSmartPtr< OdBcfBimSnippet > OdSmartPtr< OdBcfProjectExtension > OdSmartPtr< OdRxDictionary > OdSmartPtr< OdRxClass > OdSmartPtr< OdGiContextualColors > OdSmartPtr< OdGiMapperItem > OdSmartPtr< OdDbDatabase > OdSmartPtr< OdResBuf > OdSmartPtr< OdTrGL2LocalTransient > OdSmartPtr< OdGsRenderEnvironmentProperties > OdSmartPtr< OdGsProperties > OdSmartPtr< OdGsMaterialCache > OdSmartPtr< Model > OdSmartPtr< OdBcfArchiveFolder > OdSmartPtr< OdIfcGeomModule > OdSmartPtr< OdStreamBuf > OdSmartPtr< OdBcfLines > OdSmartPtr< OdGsUpdateManager > OdSmartPtr< OdGiToneOperatorParameters > OdSmartPtr< OdGiExtAccum > OdSmartPtr< OdDbOsnapPointRef > OdSmartPtr< OdBcfTopic > OdSmartPtr< OdSiSpatialIndex > OdSmartPtr< OdApcQueue > OdSmartPtr< OdGiWorldDraw > OdSmartPtr< OdGsBackgroundProperties > OdSmartPtr< OdGiOrthoClipper > OdSmartPtr< OdGiXform > OdSmartPtr< OdGsVisualStyleProperties > OdSmartPtr< OdGiVariant > OdSmartPtr< OdDbDimension > OdSmartPtr< OdBcfElement > OdSmartPtr< OdBcfComponentVisibility > OdSmartPtr< OdDbLayoutManager > OdSmartPtr< OdBcfPerspectiveCamera > OdSmartPtr< OdBcfOrthogonalCamera > OdSmartPtr< OdBcfProject > OdSmartPtr< OdBcfViewSetupHints > OdSmartPtr< OdBcfDirection > OdSmartPtr< OdDbEntity > OdSmartPtr< OdTfDwgFiler > OdSmartPtr< Repository > OdSmartPtr< OdGsHlBranchReactor > OdSmartPtr< OdDbEvalGraph > OdSmartPtr< OdHeaderSection > OdSmartPtr< OdExpSchemaModule > OdSmartPtr< OdBcfMarkup > OdSmartPtr< OdBcfComponentColoring > OdSmartPtr< OdBcfComponentSelection > OdSmartPtr< OdRxVariant > OdSmartPtr< OdGsRenderSettingsProperties > OdSmartPtr< OdGiConveyorEmbranchment > OdClsIdSmartPtr< ClsIdRetriever, T > OdRxObjectPtr OdSmartPtr< T >

Public Member Functions

OdRxObjectget () const
 
bool isNull () const
 

Protected Member Functions

 OdBaseObjectPtr ()
 
 OdBaseObjectPtr (const OdRxObject *pSource)
 

Protected Attributes

OdRxObjectm_pObject
 

Detailed Description

<group Other_Classes>

This class is the base class for typified smart pointers.

See also
TD_Db
Remarks
Smart pointers relieve the programmer of having to determine when objects are no longer needed, or having to delete them at that time.

Each object referenced by a SmartPointer (henceforth 'referenced object') maintains a reference count; i.e., how many SmartPointers are referencing it. When the reference count reaches zero, the referenced object is deleted.

See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Definition at line 50 of file BaseObjectPtr.h.

Constructor & Destructor Documentation

◆ OdBaseObjectPtr() [1/2]

OdBaseObjectPtr::OdBaseObjectPtr ( )
inlineprotected

Definition at line 55 of file BaseObjectPtr.h.

◆ OdBaseObjectPtr() [2/2]

OdBaseObjectPtr::OdBaseObjectPtr ( const OdRxObject pSource)
inlineexplicitprotected

Definition at line 56 of file BaseObjectPtr.h.

Member Function Documentation

◆ get()

OdRxObject* OdBaseObjectPtr::get ( ) const
inline

Returns the raw pointer to the referenced object.

Remarks
This class maintains the reference to the referenced object. The reference counter of the referenced object is not changed.

Definition at line 65 of file BaseObjectPtr.h.

◆ isNull()

bool OdBaseObjectPtr::isNull ( ) const
inline

Returns true if and only if the smart pointer stores a NULL.

Definition at line 70 of file BaseObjectPtr.h.

Member Data Documentation

◆ m_pObject

OdRxObject* OdBaseObjectPtr::m_pObject
protected

Definition at line 53 of file BaseObjectPtr.h.


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