#include <RxObject.h>

Inheritance diagram for OdRxObject:

Public Member Functions
	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

Static Public Member Functions
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

This class is the base class for all OdRxObject objects that require Runtime Type Identification.

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

Definition at line 563 of file RxObject.h.

Constructor & Destructor Documentation

◆ OdRxObject()

OdRxObject::OdRxObject ( )

inline

Default constructor for this class.

Definition at line 590 of file RxObject.h.

◆ ~OdRxObject()

virtual OdRxObject::~OdRxObject ( )

virtual

The virtual destructor for this class.

Member Function Documentation

◆ addRef()

virtual void OdRxObject::addRef ( )

pure virtual

Declares the method incrementing the reference counter in objects derived from this class.

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

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

◆ cast()

static OdRxObjectPtr OdRxObject::cast ( const OdRxObject * pointer )

inlinestatic

Casts the specified raw pointer to the smart pointer.

Parameters

pointer [in] Raw pointer to be cast.

Definition at line 640 of file RxObject.h.

◆ clone()

virtual OdRxObjectPtr OdRxObject::clone ( ) const

virtual

Creates a clone of this object, and returns a pointer to the clone.

◆ comparedTo()

virtual OdRx::Ordering OdRxObject::comparedTo ( const OdRxObject * pOther ) const

virtual

Compares another object to this one in a some meaning.

Parameters

pOther [in] Raw pointer to the object to be compared.

Remarks: This method returns one of the following:

Value Description
kLessThan -1 This object < Other Object.
kEqual 0 This object = Other Object.
kGreaterThan 1 This object > Other Object.
kNotOrderable 2 This class is not orderable.

Remarks: The default implementation of this method returns kNotOrderable.

See also: <link rx_object_compare_moreless.html, Comparing the Value of Rx Objects>; <link rx_object_compare.html, Comparing Rx-Objects>

Reimplemented in OdRxBoxedValue.

◆ copyFrom()

virtual void OdRxObject::copyFrom ( const OdRxObject * pSource )

virtual

details Copies the contents of the specified object into this object.

Parameters

pSource [in] Pointer to the source object.

Remarks: The default implementation of this function does nothing but throw an eNotApplicable exception.

Throws: eNotApplicable Exception

◆ desc()

static OdRxClass * OdRxObject::desc ( )

static

Returns the raw pointer to the class describing instance statically associated with this object as the OdRxClass object.

Remarks: This function is for use only when the class type of this object is known. If the class type of this object is unknown, use isA() method instead.

See also: <link rtti_sample_identifying.html, Example of Identifying Classes>; <link rtti_class_functionality.html, Functionality of RTTI>

◆ isA()

virtual OdRxClass * OdRxObject::isA ( ) const

virtual

Returns the raw pointer to the class describing instance dynamically associated with this object as the OdRxClass object.

Remarks: This function is for use only when the class type of this object is unknown. If the class type of this object is known, use desc() method instead.

See also: <link rtti_sample_identifying.html, Example of Identifying Classes>; <link rtti_class_functionality.html, Functionality of RTTI>

Reimplemented in CFxEditorReactor, and OdGiBaseVectorizer.

◆ isEqualTo()

virtual bool OdRxObject::isEqualTo ( const OdRxObject * pOther ) const

virtual

Returns true if and only if the specified object is equal to this one in a some meaning.

Parameters

pOther [in] Raw pointer to the object to be compared.

See also: <link rx_object_compare_equivalence.html, Comparing the Equivalence of Rx Objects>; <link rx_object_compare.html, Comparing Rx-Objects>

Reimplemented in OdRxBoxedValue.

◆ isKindOf()

bool OdRxObject::isKindOf ( const OdRxClass * pClass ) const

inline

Checks whether the object belongs to the specified class and returns true if and only if this object is an instance of the specified class or a subclass of the specified class.

Parameters

pClass [in] Raw pointer to the class describing instance to be checked.

See also: <link rtti_sample_belonging.html, Example of Belonging to an Instance of a Class>; <link rtti_class_belonging.html, Belonging to an Instance of a Class>

Definition at line 1109 of file RxObject.h.

◆ numRefs()

virtual long OdRxObject::numRefs ( ) const

virtual

Returns the value of the reference counter, that is, the number of references to an instance of this class.

Remarks: This method has the default implementation that returns 1. You should redefine it in the derived class.

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

Reimplemented in OdDbCompoundObjectId, OdDbGeoDataProvidersString, OdDbObject, OdGsRedirectionHelper< OdGsCache >, OdGsRedirectionHelper< OdGsModelRedirectionWrapper< OdGsModelRedirectionHandler > >, OdRxObjectImpl< OdDbGeomRef >, OdRxObjectImpl< OdDbSubentRef >, OdRxObjectImpl< OdRxDictionaryIterator >, and OdRxObjectImpl< OdRxObject, AECImpObj >.

◆ ODRX_HEAP_OPERATORS()

OdRxObject::ODRX_HEAP_OPERATORS ( )

Protects derived OdRxObject objects from direct use of new and delete operators.

◆ queryX()

virtual OdRxObject * OdRxObject::queryX ( const OdRxClass * pClass ) const

virtual

Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class.

Parameters

pClass [in] Raw pointer to the class describing instance to which the object must be converted.

Remarks: If the object cannot be converted, the method returns a Null. The program must release this object, if the returned pointer is not Null.

See also: <link rtti_sample_belonging.html, Example of Belonging to an Instance of a Class>; <link rtti_class_belonging.html, Belonging to an Instance of a Class>

Reimplemented in CFxEditorReactor, and OdGiBaseVectorizer.

◆ release()

virtual void OdRxObject::release ( )

pure virtual

Declares the method decrementing the reference counter in objects derived from this class.

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

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

◆ rxInit()

static void OdRxObject::rxInit ( )

static

◆ rxUninit()

static void OdRxObject::rxUninit ( )

static

◆ x()

virtual OdRxObject * OdRxObject::x ( const OdRxClass * pClass ) const

virtual

Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot.

Parameters

pClass [in] Raw pointer to the class describing instance to which the object must be converted.

Remarks: This method generates the eNotThatKindOfClass exception when the object can be not converted to the specified class. This method generates the eInvalidInput exception when the argument pClass is Null. This method uses the queryX() method.

See also: <link rtti_sample_belonging.html, Example of Belonging to an Instance of a Class>; <link rtti_class_belonging.html, Belonging to an Instance of a Class>

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

RxObject.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OdRxObject()

◆ ~OdRxObject()

Member Function Documentation

◆ addRef()

◆ cast()

◆ clone()

◆ comparedTo()

◆ copyFrom()

◆ desc()

◆ isA()

◆ isEqualTo()

◆ isKindOf()

◆ numRefs()

◆ ODRX_HEAP_OPERATORS()

◆ queryX()

◆ release()

◆ rxInit()

◆ rxUninit()

◆ x()