CFx SDK Documentation  2023 SP0
Classes | Public Member Functions | Protected Member Functions | List of all members
OdRxClassProtocolExtImpl Class Reference

#include <RxClassImpl.h>

Inheritance diagram for OdRxClassProtocolExtImpl:
OdRxClass OdRxObject OdRxBaseClassImpl OdRxBaseNamedClassImpl OdRxClassConsImpl OdRxNamedClassImpl OdDxfClassImpl OdRxValueType OdRxNonBlittableType< ValueType > OdRxNonBlittableType< T > OdRxSpecifiedValueType OdRxValueTypePOD< ValueType > OdRxNonBlittableWithUnderlyingType< ValueType > AggrValueTypePOD< ValueType > OdDAISelectValueTypePOD< ValueType > OdRxEnumType< ValueType > OdRxValueWithReferenceTypePOD< ValueType > OdRxValueWithUnderlyingTypePOD< ValueType > OdRxEnumWithUnderlyingType< ValueType >

Classes

class  ExtEntry
 

Public Member Functions

 ~OdRxClassProtocolExtImpl ()
 
OdRxObjectPtr addX (OdRxClass *pProtocolClass, OdRxObject *pProtocolObject)
 
OdRxObjectPtr getX (const OdRxClass *pProtocolClass)
 
OdRxObjectPtr delX (OdRxClass *pProtocolClass)
 
void setConstructor (OdPseudoConstructorType pConstr)
 
OdRxObjectPtr create () const
 
const OdString dxfName () const
 
const OdString appName () const
 
AppNameChangeFuncPtr appNameCallbackPtr () const
 
OdUInt32 proxyFlags () const
 
OdDb::DwgVersion getClassVersion (OdDb::MaintReleaseVer *pMaintVer=0) const
 
OdUInt32 customFlags () const
 
- Public Member Functions inherited from OdRxClass
 ODRX_DECLARE_MEMBERS (OdRxClass)
 
virtual const OdString name () const =0
 
virtual bool isDerivedFrom (const OdRxClass *pClass) const
 
virtual OdRxClassmyParent () const =0
 
virtual OdRxModulemodule () const =0
 
virtual OdPseudoConstructorType constructor ()
 
virtual OdRxOverruleIterator * getOverrule (OverrulingType t) const =0
 
virtual void setOverrule (OdRxOverruleIterator *pIt, OverrulingType t)=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
 

Protected Member Functions

 OdRxClassProtocolExtImpl ()
 
- Protected Member Functions inherited from OdRxClass
 OdRxClass ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Definition at line 32 of file RxClassImpl.h.

Constructor & Destructor Documentation

◆ OdRxClassProtocolExtImpl()

OdRxClassProtocolExtImpl::OdRxClassProtocolExtImpl ( )
protected

◆ ~OdRxClassProtocolExtImpl()

OdRxClassProtocolExtImpl::~OdRxClassProtocolExtImpl ( )

Member Function Documentation

◆ addX()

OdRxObjectPtr OdRxClassProtocolExtImpl::addX ( OdRxClass pProtocolClass,
OdRxObject pProtocolObject 
)
virtual

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.

Reimplemented from OdRxClass.

◆ appName()

const OdString OdRxClassProtocolExtImpl::appName ( ) const
virtual

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>

Implements OdRxClass.

Reimplemented in OdDxfClassImpl.

◆ appNameCallbackPtr()

AppNameChangeFuncPtr OdRxClassProtocolExtImpl::appNameCallbackPtr ( ) const
virtual

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>

Implements OdRxClass.

Reimplemented in OdDxfClassImpl.

◆ create()

OdRxObjectPtr OdRxClassProtocolExtImpl::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>

Implements OdRxClass.

Reimplemented in OdRxValueType, and OdRxClassConsImpl.

◆ customFlags()

OdUInt32 OdRxClassProtocolExtImpl::customFlags ( ) const
virtual

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>

Implements OdRxClass.

Reimplemented in OdDxfClassImpl.

◆ delX()

OdRxObjectPtr OdRxClassProtocolExtImpl::delX ( OdRxClass pProtocolClass)
virtual

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.

Reimplemented from OdRxClass.

◆ dxfName()

const OdString OdRxClassProtocolExtImpl::dxfName ( ) const
virtual

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>

Implements OdRxClass.

Reimplemented in OdDxfClassImpl.

◆ getClassVersion()

OdDb::DwgVersion OdRxClassProtocolExtImpl::getClassVersion ( OdDb::MaintReleaseVer pMaintReleaseVer = 0) const
virtual

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>

Implements OdRxClass.

Reimplemented in OdDxfClassImpl.

◆ getX()

OdRxObjectPtr OdRxClassProtocolExtImpl::getX ( const OdRxClass pProtocolClass)
virtual

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.

Reimplemented from OdRxClass.

◆ proxyFlags()

OdUInt32 OdRxClassProtocolExtImpl::proxyFlags ( ) const
virtual

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>

Implements OdRxClass.

Reimplemented in OdDxfClassImpl.

◆ setConstructor()

void OdRxClassProtocolExtImpl::setConstructor ( OdPseudoConstructorType  psuedoConstr)
virtual

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>

Implements OdRxClass.

Reimplemented in OdRxClassConsImpl.


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