#include <RxAttribute.h>

Inheritance diagram for OdRxDisplayAsAttribute:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxDisplayAsAttribute)

OdString	propertyName ()

virtual OdString	getDisplayValue (OdRxValue &value, bool useDynamicProperties=true)

	OdRxDisplayAsAttribute (OdRxDisplayAsAttributeImpl *pImpl)

	OdRxDisplayAsAttribute ()

Public Member Functions inherited from OdRxAttribute
	ODRX_DECLARE_MEMBERS (OdRxAttribute)

virtual	~OdRxAttribute ()

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 OdRxAttributePtr	createObject (const OdString &property_name)

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

static OdRxClass *	desc ()

Additional Inherited Members
Protected Member Functions inherited from OdRxAttribute
	OdRxAttribute (OdRxAttributeImpl *)

Protected Attributes inherited from OdRxAttribute
OdRxAttributeImpl *	m_pImpl

Detailed Description

This attribute can be used by UI to represent properties of dereferenceable types in human readable form (instead of displaying just a handle).

Definition at line 920 of file RxAttribute.h.

Constructor & Destructor Documentation

◆ OdRxDisplayAsAttribute() [1/2]

OdRxDisplayAsAttribute::OdRxDisplayAsAttribute ( OdRxDisplayAsAttributeImpl * pImpl )

◆ OdRxDisplayAsAttribute() [2/2]

OdRxDisplayAsAttribute::OdRxDisplayAsAttribute ( )

Member Function Documentation

◆ createObject()

static OdRxAttributePtr OdRxDisplayAsAttribute::createObject ( const OdString & property_name )

static

Constructor. Creates an attribute of the OdRxDisplayAsAttribute type.

Parameters

property_name [in] The name of the property of the dereferenced object to use instead of the object ID.

Returns: Smart pointer to a constructed attribute object.

◆ getDisplayValue()

virtual OdString OdRxDisplayAsAttribute::getDisplayValue	(	OdRxValue &	value,
		bool	useDynamicProperties = `true`
	)

virtual

By default this function dereferences the value and retrieves the property which name is stored in the attribute.

Parameters

value	[in] Value to dereference and retrieve the property of.
useDynamicProperties	[in] Flag to optimize getting the displayed value. It can be set to false only if all properties of database objects are statically dependent on the object type. Default value is true.

Returns: Name of the property of the dereferenced object to use instead of the object ID. If the value type is not a reference or the referenced object has no such property, returns an empty string.

Remarks: Can be overloaded in custom implementations.

Reimplemented in OdIfcRxDisplayAsAttribute.

◆ ODRX_DECLARE_MEMBERS()

OdRxDisplayAsAttribute::ODRX_DECLARE_MEMBERS ( OdRxDisplayAsAttribute )

◆ propertyName()

OdString OdRxDisplayAsAttribute::propertyName ( )

Retrieves the name of the property of the dereferenced object to use instead of the object ID.

Returns: Name of the property of the dereferenced object to use instead of the object ID.

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

RxAttribute.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members