CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdTrVisDescStub Class Reference

#include <TrVisDefs.h>

Inheritance diagram for OdTrVisDescStub:
OdRxClass OdRxObject OdStaticRxObject< OdTrVisDescStub >

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

Library: Source code provided. <group ExRender_Windows_Classes>

Definition at line 235 of file TrVisDefs.h.

Member Function Documentation

◆ appName()

const OdString OdTrVisDescStub::appName ( ) const
inlinevirtual

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.

Definition at line 239 of file TrVisDefs.h.

◆ appNameCallbackPtr()

AppNameChangeFuncPtr OdTrVisDescStub::appNameCallbackPtr ( ) const
inlinevirtual

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.

Definition at line 240 of file TrVisDefs.h.

◆ create()

OdRxObjectPtr OdTrVisDescStub::create ( ) const
inlinevirtual

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.

Definition at line 238 of file TrVisDefs.h.

◆ customFlags()

OdUInt32 OdTrVisDescStub::customFlags ( ) const
inlinevirtual

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.

Definition at line 245 of file TrVisDefs.h.

◆ dxfName()

const OdString OdTrVisDescStub::dxfName ( ) const
inlinevirtual

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.

Definition at line 241 of file TrVisDefs.h.

◆ getClassVersion()

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

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.

Definition at line 243 of file TrVisDefs.h.

◆ getOverrule()

OdRxOverruleIterator* OdTrVisDescStub::getOverrule ( OverrulingType  t) const
inlinevirtual

Implements OdRxClass.

Definition at line 249 of file TrVisDefs.h.

◆ module()

OdRxModule* OdTrVisDescStub::module ( ) const
inlinevirtual

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>

Implements OdRxClass.

Definition at line 247 of file TrVisDefs.h.

◆ myParent()

OdRxClass* OdTrVisDescStub::myParent ( ) const
inlinevirtual

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>

Implements OdRxClass.

Definition at line 246 of file TrVisDefs.h.

◆ name()

const OdString OdTrVisDescStub::name ( ) const
inlinevirtual

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>

Implements OdRxClass.

Definition at line 242 of file TrVisDefs.h.

◆ proxyFlags()

OdUInt32 OdTrVisDescStub::proxyFlags ( ) const
inlinevirtual

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.

Definition at line 244 of file TrVisDefs.h.

◆ setConstructor()

void OdTrVisDescStub::setConstructor ( OdPseudoConstructorType  psuedoConstr)
inlinevirtual

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.

Definition at line 248 of file TrVisDefs.h.

◆ setOverrule()

void OdTrVisDescStub::setOverrule ( OdRxOverruleIterator *  pIt,
OverrulingType  t 
)
inlinevirtual

Implements OdRxClass.

Definition at line 250 of file TrVisDefs.h.

The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:11:11