CFx SDK Documentation  2020SP3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OdRxMember Class Reference

#include <RxMember.h>

Inheritance diagram for OdRxMember:
OdRxObject OdRxCategory OdRxEnumTag OdRxMethod OdRxPropertyBase OdRxCollectionProperty OdRxProperty OdRxDictionaryProperty OdRxIndexedProperty OdRxSubProperty OdRxIndexedSubProperty OdRxSubPropertyOfIndexedProperty

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxMember)
 
const OdStringname () const throw ()
 
OdString localName () const throw ()
 
const OdRxValueTypetype () const throw ()
 
const OdRxAttributeCollectionattributes () const throw ()
 
OdRxAttributeCollectionattributes () throw ()
 
const OdRxObjectowner () const throw ()
 
const OdArray< OdRxMemberPtr > * children () const throw ()
 
- 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
 

Static Public Member Functions

static void deleteMember (const OdRxMember *pMember) throw ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

virtual ~OdRxMember ()
 
 OdRxMember (OdRxMemberImpl *)
 
virtual OdString subLocalName () const
 
virtual OdResult subChildren (OdArray< OdRxMemberPtr > &children) const
 
virtual OdResult subChildrenEx (OdArray< OdRxMemberPtr > *&pChildren) const
 
void init (const OdString &name, const OdRxValueType *type, const OdRxObject *owner=0)
 

Protected Attributes

OdRxMemberImplm_pImpl
 

Friends

class OdRxMemberImpl
 

Detailed Description

Base class for properties and methods.

<group OdRx_Classes>

Definition at line 51 of file RxMember.h.

Constructor & Destructor Documentation

◆ ~OdRxMember()

virtual OdRxMember::~OdRxMember ( )
protectedvirtual

◆ OdRxMember()

OdRxMember::OdRxMember ( OdRxMemberImpl )
protected

Member Function Documentation

◆ attributes() [1/2]

OdRxAttributeCollection& OdRxMember::attributes ( )
throw (
)

◆ attributes() [2/2]

const OdRxAttributeCollection& OdRxMember::attributes ( ) const
throw (
)

Attributes are used on some properties to modify their behaviour. E.g. OdRxLocalizedNameAttribute defines localName() look at RxAttributes.h for more info

◆ children()

const OdArray<OdRxMemberPtr>* OdRxMember::children ( ) const
throw (
)

Some properties may have child properties, e.g. "EndPoint" property of OdDbLine has subproperties "EndPoint/X", "EndPoint/Y", "EndPoint/Z"

◆ deleteMember()

static void OdRxMember::deleteMember ( const OdRxMember pMember)
throw (
)
static

This method should be used to delete properties while unloading. It removes this member from the owner, and fires "goodbye" reactors registered with the OdRxMemberQueryEngine.

◆ init()

void OdRxMember::init ( const OdString name,
const OdRxValueType type,
const OdRxObject owner = 0 
)
protected

Initialization method used by descendants to assign unlocalized name, type and owner of this member.

◆ localName()

OdString OdRxMember::localName ( ) const
throw (
)

Localized name (may be loaded from resources via OdRxLocalizedNameAttribute::getLocalizedName)

◆ name()

const OdString& OdRxMember::name ( ) const
throw (
)

Static unlocalized name of the property.

◆ ODRX_DECLARE_MEMBERS()

OdRxMember::ODRX_DECLARE_MEMBERS ( OdRxMember  )

◆ owner()

const OdRxObject* OdRxMember::owner ( ) const
throw (
)

For the usual properties owner is the OdRxClass they are attached to. For subproperties owner is the main property.

◆ subChildren()

virtual OdResult OdRxMember::subChildren ( OdArray< OdRxMemberPtr > &  children) const
protectedvirtual

First call to children call subChildren, if it returned eNotApplicable then subChildrenEx is called. subChildren is expected to adds members children array.

◆ subChildrenEx()

virtual OdResult OdRxMember::subChildrenEx ( OdArray< OdRxMemberPtr > *&  pChildren) const
protectedvirtual

subChildrenEx allows adding properties in bulk. pChildren array is managed by the function itself.

◆ subLocalName()

virtual OdString OdRxMember::subLocalName ( ) const
protectedvirtual

Descendants may overload localized name obtaining method.

◆ type()

const OdRxValueType& OdRxMember::type ( ) const
throw (
)

Property type.

Friends And Related Function Documentation

◆ OdRxMemberImpl

friend class OdRxMemberImpl
friend

Definition at line 93 of file RxMember.h.

Member Data Documentation

◆ m_pImpl

OdRxMemberImpl* OdRxMember::m_pImpl
protected

Definition at line 117 of file RxMember.h.


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