OdRxMember Class Reference

#include <RxMember.h>

Inheritance diagram for OdRxMember:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxMember)
const OdString &	name () const throw ()
OdString	localName () const throw ()
const OdRxValueType &	type () const throw ()
const OdRxAttributeCollection &	attributes () const throw ()
OdRxAttributeCollection &	attributes () throw ()
const OdRxObject *	owner () const throw ()
const OdArray< OdRxMemberPtr > *	children () const throw ()
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

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 OdRxClass *	desc ()

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
OdRxMemberImpl *	m_pImpl

Friends
class	OdRxMemberImpl

Detailed Description

Base class for properties and methods.

<group OdRx_Classes>

Definition at line 58 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	(
	)

Gets the attributes that are used on some properties to modify their behavior. E.g., OdRxLocalizedNameAttribute defines localName(). See RxAttributes.h for more information.

Returns

Collection of property attributes.

attributes() [2/2]

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

Gets the attributes that are used on some properties to modify their behavior. E.g., OdRxLocalizedNameAttribute defines localName(). See RxAttributes.h for more information.

Returns

Collection of property attributes.

children()

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

Gets the array of subproperties (child properties).

Returns

Array of subproperties (child properties).

Remarks

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

Removes this member from the owner and fires "goodbye" reactors registered with the OdRxMemberQueryEngine.

Parameters

pMember

[in] Property to be removed.

Remarks

This method should be used to delete properties while unloading.

init()

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

protected

Assigns an unlocalized name, type and owner to this member.

Remarks

Initialization method used by descendants.

localName()

OdString OdRxMember::localName	(		)	const
throw	(
	)

Gets the localized name (can be loaded from resources via OdRxLocalizedNameAttribute::getLocalizedName).

Returns

Localized name of the property.

name()

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

Gets the static unlocalized name of the property.

Returns

Name of the property.

ODRX_DECLARE_MEMBERS()

OdRxMember::ODRX_DECLARE_MEMBERS

(

OdRxMember

)

owner()

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

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

Returns

Owner of the property.

subChildren()

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

protectedvirtual

Adds an array of member children.

Parameters

children

[in] An array of children.

Returns

eOk if a member child array is added successfully, or a corresponding error type otherwise.

Remarks

First call to children calls 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

Adds properties in bulk.

Returns

eOk if properties are added in bulk successfully, or a corresponding error type otherwise.

Remarks

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	(
	)

Gets the property value type.

Returns

Property value type.

Friends And Related Function Documentation

OdRxMemberImpl

friend class OdRxMemberImpl

friend

Definition at line 140 of file RxMember.h.

Member Data Documentation

m_pImpl

OdRxMemberImpl* OdRxMember::m_pImpl

protected

Definition at line 176 of file RxMember.h.

---

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

• RxMember.h