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

#include <RxProperty.h>

Inheritance diagram for OdRxProperty:
OdRxPropertyBase OdRxMember OdRxObject OdRxSubProperty

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxProperty)
 
 OdRxProperty ()
 
OdResult getValue (const OdRxObject *pO, OdRxValue &value) const
 
OdResult setValue (OdRxObject *pO, const OdRxValue &value) const
 
- Public Member Functions inherited from OdRxPropertyBase
 ODRX_DECLARE_MEMBERS (OdRxPropertyBase)
 
virtual bool isReadOnly (const OdRxObject *pO) const
 
- Public Member Functions inherited from OdRxMember
 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
 

Protected Member Functions

virtual OdResult subGetValue (const OdRxObject *pO, OdRxValue &value) const
 
virtual OdResult subSetValue (OdRxObject *pO, const OdRxValue &value) const
 
 OdRxProperty (OdRxPropertyImpl *)
 
- Protected Member Functions inherited from OdRxPropertyBase
 OdRxPropertyBase (OdRxPropertyBaseImpl *)
 
- Protected Member Functions inherited from OdRxMember
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)
 

Friends

class OdRxPropertyImpl
 
class OdRxPropertyOverrule
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxMember
static void deleteMember (const OdRxMember *pMember) throw ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
- Protected Attributes inherited from OdRxMember
OdRxMemberImpl * m_pImpl
 

Detailed Description

<group OdRx_Classes> Scalar property class. Represent a proxy access to some object property. Usable in property palettes, fields evaluation etc.

Definition at line 85 of file RxProperty.h.

Constructor & Destructor Documentation

◆ OdRxProperty() [1/2]

OdRxProperty::OdRxProperty ( )

◆ OdRxProperty() [2/2]

OdRxProperty::OdRxProperty ( OdRxPropertyImpl *  )
protected

Member Function Documentation

◆ getValue()

OdResult OdRxProperty::getValue ( const OdRxObject *  pO,
OdRxValue &  value 
) const

Get the property value.

Parameters
pO[in] The object which property to retrieve.
value[out] Resulting value.
Returns
Returns eOk if successful.

◆ ODRX_DECLARE_MEMBERS()

OdRxProperty::ODRX_DECLARE_MEMBERS ( OdRxProperty  )

◆ setValue()

OdResult OdRxProperty::setValue ( OdRxObject *  pO,
const OdRxValue &  value 
) const

Set the property value.

Parameters
pO[in] The object which property to set.
value[in] Property value to set.
Returns
Returns eOk if successful. If it returns eNotApplicable the property is considered read-only.

◆ subGetValue()

virtual OdResult OdRxProperty::subGetValue ( const OdRxObject *  pO,
OdRxValue &  value 
) const
protectedvirtual

Method called by getValue() to actually get the value. To be overloaded by the property implementation.

Reimplemented in OdRxSubProperty.

◆ subSetValue()

virtual OdResult OdRxProperty::subSetValue ( OdRxObject *  pO,
const OdRxValue &  value 
) const
protectedvirtual

Method called by setValue() to actually set the value. To be overloaded by the property implementation.

Reimplemented in OdRxSubProperty.

Friends And Related Function Documentation

◆ OdRxPropertyImpl

friend class OdRxPropertyImpl
friend

Definition at line 116 of file RxProperty.h.

◆ OdRxPropertyOverrule

friend class OdRxPropertyOverrule
friend

Definition at line 117 of file RxProperty.h.


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