OdIfcRxDisplayAsAttribute Class Reference

#include <IfcValueTypes.h>

Inheritance diagram for OdIfcRxDisplayAsAttribute:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdIfcRxDisplayAsAttribute)
virtual OdString	getDisplayValue (OdRxValue &value, bool useDynamicProperties)
void	setShowObjectType (bool val)
void	setShowIndex (bool val)
Public Member Functions inherited from OdRxDisplayAsAttribute
	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 (bool bShowIndex, bool bShowObjectType)
Static Public Member Functions inherited from OdRxDisplayAsAttribute
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

The class implements an IFC attribute that can be used by the user interface to represent property values in a human-readable form (instead of displaying just a handle).

Definition at line 45 of file IfcValueTypes.h.

Member Function Documentation

createObject()

static OdRxAttributePtr OdIfcRxDisplayAsAttribute::createObject ( bool  bShowIndex, bool  bShowObjectType  )

static

Createa a new IFC attribute instance with specified parameters.

Parameters

bShowIndex	[in] A flag that determines whether the index of the created attributes should be shown.
bShowObjectType	[in] A flag that determines whether the type of the created attributes should be shown.

Returns

A smart pointer to the created attribut object.

getDisplayValue()

virtual OdString OdIfcRxDisplayAsAttribute::getDisplayValue ( OdRxValue &  value, bool  useDynamicProperties  )

virtual

Dereferences the IFC attribute value and retrieves the property which name is stored in the attribute.

Parameters

value	[in] A value to dereference and retrieve the property of.
useDynamicProperties	[in] A flag that determines whether the getting of the displayed value should be optimized (is equal to true) or not (is equal to false).

Returns

The name of the dereferenced object's property to use instead of the object identifier. If the passed value type is not a reference or the referenced object has no such property, the method returns an empty string.

Remarks

The useDynamicProperties flag can be set to false only if all properties of the database objects are statically dependent on the object type.

Reimplemented from OdRxDisplayAsAttribute.

ODRX_DECLARE_MEMBERS()

OdIfcRxDisplayAsAttribute::ODRX_DECLARE_MEMBERS

(

OdIfcRxDisplayAsAttribute

)

setShowIndex()

void OdIfcRxDisplayAsAttribute::setShowIndex

(

bool

val

)

Sets the new value of the flag that determines whether the attribute index is displayed. If the flag value is equal to true, the index is displayed; otherwise (the flag value is equal to false), the index is not displayed.

Parameters

val	[in] A new flag value to be set.

setShowObjectType()

void OdIfcRxDisplayAsAttribute::setShowObjectType

(

bool

val

)

Sets the new value of the flag that determines whether the attribute type is displayed. If the flag value is equal to true, the type is displayed; otherwise (the flag value is equal to false), the type is not displayed.

Parameters

val	[in] A new flag value to be set.

---

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

• IfcValueTypes.h