#include <RxObject.h>

Inheritance diagram for OdRxClass:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxClass)

	OdRxClass ()

	~OdRxClass ()

OdRxObjectPtr	addX (OdRxClass pProtocolClass, OdRxObject pProtocolObject)

OdRxObjectPtr	getX (const OdRxClass *pProtocolClass)

OdRxObjectPtr	delX (OdRxClass *pProtocolClass)

virtual OdRxObjectPtr	create () const

const OdString	appName () const

AppNameChangeFuncPtr	appNameCallbackPtr () const

const OdString	dxfName () const

const OdString	name () const

OdDb::DwgVersion	getClassVersion (OdDb::MaintReleaseVer *pMaintReleaseVer=0) const

OdUInt32	proxyFlags () const

virtual bool	isDerivedFrom (const OdRxClass *pClass) const

OdRxClass *	myParent () const

OdRxModule *	module () const

OdPseudoConstructorType	constructor ()

void	setConstructor (OdPseudoConstructorType psuedoConstr)

OdUInt32	customFlags () const

OdRxMemberCollection *	members () const

const OdRxAttributeCollection &	attributes () const

OdRxAttributeCollection &	attributes ()

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

Protected Member Functions
	OdRxClass (OdRxClassImpl *)

Protected Attributes
OdRxClassImpl *	m_pImpl

Friends
class	OdRxClassImpl

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

<group OdRx_Classes> Contains runtime information about a Rx-Object.

Remarks: A pointer to an OdRxClass instance can be obtained for an OdRxObject class by calling the OdRxObject::desc() function.

See also: <link rtti.html, RTTI Technology>

Definition at line 859 of file RxObject.h.

Constructor & Destructor Documentation

◆ OdRxClass() [1/2]

OdRxClass::OdRxClass ( OdRxClassImpl * )

protected

◆ OdRxClass() [2/2]

OdRxClass::OdRxClass ( )

◆ ~OdRxClass()

OdRxClass::~OdRxClass ( )

Member Function Documentation

◆ addX()

OdRxObjectPtr OdRxClass::addX	(	OdRxClass *	pProtocolClass,
		OdRxObject *	pProtocolObject
	)

Creates the Protocol Extension for the specified OdRxClass.

Parameters

pProtocolClass	[in] Pointer to the Protocol Extension class.
pProtocolObject	[in] Pointer to the Protocol Extension Object.

Returns: Returns a SmartPointer to the Protocol Extension.

Remarks: The default implementation of this object does nothing but return a null pointer, and asserts in debug mode. It will be fully implemented in a future release.

◆ appName()

const OdString OdRxClass::appName ( ) const

Returns the application class name for the class describing instance represented by this OdRxClass object. Custom class can alter its application name depending on file format version it's being saved to.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ appNameCallbackPtr()

AppNameChangeFuncPtr OdRxClass::appNameCallbackPtr ( ) const

Returns a pointer to the callback function which is called when a drawing is to be saved and the logical application class name represented by the class description instance to be written out to file for the custom class, or NULL, if the callback function is not assigned.

See also: <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ attributes() [1/2]

OdRxAttributeCollection & OdRxClass::attributes ( )

◆ attributes() [2/2]

const OdRxAttributeCollection & OdRxClass::attributes ( ) const

◆ constructor()

OdPseudoConstructorType OdRxClass::constructor ( )

Returns the raw pointer to the function that is the pseudo-constructor for this class.

See also: <link rtti_class_constructors.html, Functionality of Pseudo-Constructors>; <link rtti_pseudoconstructor.html, Understanding Pseudo-Constructors>

◆ create()

virtual OdRxObjectPtr OdRxClass::create ( ) const

virtual

Creates a new instance of the class associated with the class describing instance using the pseudo-constructor of the class.

Returns: Returns a smart pointer to the newly created instance.

See also: <link rtti_class_constructors.html, Functionality of Pseudo-Constructors>; <link rtti_pseudoconstructor.html, Understanding Pseudo-Constructors>

Reimplemented in OdRxValueType.

◆ customFlags()

OdUInt32 OdRxClass::customFlags ( ) const

Returns the custom flags for the class describing instance represented by this OdRxClass object.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ delX()

OdRxObjectPtr OdRxClass::delX ( OdRxClass * pProtocolClass )

Deletes the Protocol Extension for the specified Protocol Extension class.

Returns: Returns the Protocol Extension Object.

Parameters

pProtocolClass [in] Pointer to the Protocol Extension class.

Remarks: As currently implemented, this function does nothing but assert in debug mode, and return a null pointer. It will be fully implemented in a future release.

◆ dxfName()

const OdString OdRxClass::dxfName ( ) const

Returns the DXF class name for the class describing instance represented by this OdRxClass object.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ getClassVersion()

OdDb::DwgVersion OdRxClass::getClassVersion ( OdDb::MaintReleaseVer * pMaintReleaseVer = 0 ) const

Returns the .dwg file version and maintenance version for the class describing instance represented by this OdRxClass object.

Parameters

pMaintReleaseVer [in] Raw pointer to the variable in which the maintenance version number must be saved. This variable must have the OdDb::MaintReleaseVer type.

Remarks: The .dwg file version number is returned value of the method that must have the OdDb::DwgVersion type. This method returns the maintenance release version if and only if its argument is not Null.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ getX()

OdRxObjectPtr OdRxClass::getX ( const OdRxClass * pProtocolClass )

Returns the Protocol Extension for the specified Protocol extension class.

Parameters

pProtocolClass [in] Pointer to the Protocol Extension class.

Returns: Returns a SmartPointer to the Protocol Extension.

Remarks: The default implementation of this object does nothing but assert in debug mode, and return a null pointer. It will be fully implemented in a future release.

◆ isDerivedFrom()

virtual bool OdRxClass::isDerivedFrom ( const OdRxClass * pClass ) const

virtual

Checks whether the class defined by this class describing instance belongs to or derived from the specified class. The method 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>

◆ members()

OdRxMemberCollection * OdRxClass::members ( ) const

◆ module()

OdRxModule * OdRxClass::module ( ) const

Returns the OdRxModule object in which the class is resided.

Remarks: The default implementation of this function returns a Null pointer.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ myParent()

OdRxClass * OdRxClass::myParent ( ) const

Returns the raw pointer to the class describing instance which describes the parent class for this class as the OdRxClass object.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ name()

const OdString OdRxClass::name ( ) const

Returns the class name for the class describing instance represented by this OdRxClass object.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ ODRX_DECLARE_MEMBERS()

OdRxClass::ODRX_DECLARE_MEMBERS ( OdRxClass )

◆ proxyFlags()

OdUInt32 OdRxClass::proxyFlags ( ) const

Returns the /proxy flags/ for the class describing instance represented by this OdRxClass object.

See also: <link rtti_class_functionality.html, Functionality of RTTI>; <link rtti_class_describing.html, Implementing the Class Describing Structure>

◆ setConstructor()

void OdRxClass::setConstructor ( OdPseudoConstructorType psuedoConstr )

Sets the user-defined function as the pseudo-constructor for this class.

Parameters

pseudoConstr [in] Raw pointer to the user-defined function that does not have arguments and returns the smart pointer to a new instance of this class.

See also: <link rtti_class_constructors.html, Functionality of Pseudo-Constructors>; <link rtti_pseudoconstructor.html, Understanding Pseudo-Constructors>

Friends And Related Function Documentation

◆ OdRxClassImpl

friend class OdRxClassImpl

friend

Definition at line 861 of file RxObject.h.

Member Data Documentation

◆ m_pImpl

OdRxClassImpl* OdRxClass::m_pImpl

protected

Definition at line 863 of file RxObject.h.

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

RxObject.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdRxClass() [1/2]

◆ OdRxClass() [2/2]

◆ ~OdRxClass()

Member Function Documentation

◆ addX()

◆ appName()

◆ appNameCallbackPtr()

◆ attributes() [1/2]

◆ attributes() [2/2]

◆ constructor()

◆ create()

◆ customFlags()

◆ delX()

◆ dxfName()

◆ getClassVersion()

◆ getX()

◆ isDerivedFrom()

◆ members()

◆ module()

◆ myParent()

◆ name()

◆ ODRX_DECLARE_MEMBERS()

◆ proxyFlags()

◆ setConstructor()

Friends And Related Function Documentation

◆ OdRxClassImpl

Member Data Documentation

◆ m_pImpl