OdTfProperty Class Reference

#include <TfObject.h>

Inheritance diagram for OdTfProperty:

Public Member Functions
virtual OdTfClass *	owner () const =0
virtual OdTfVariant::Type	type () const =0
virtual const OdString &	name () const =0
virtual OdTfAttributesContainerPtr	attributes () const =0
virtual OdTfVariant	defaultItemValue () const =0
virtual OdResult	getValue (const OdTfObject *pObject, OdTfVariant &value) const =0
virtual OdResult	setValue (OdTfObject *pObject, const OdTfVariant &value) const =0
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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

An abstract interface class that provides functionality for storing property data. A property is defined with its name, data type, value and a set of property attributes. Corresponding C++ library: Od_Tf <group OdTf_Classes>

Definition at line 314 of file TfObject.h.

Member Function Documentation

attributes()

virtual OdTfAttributesContainerPtr OdTfProperty::attributes ( ) const

pure virtual

Retrieves the property attributes.

Returns

Returns a smart pointer to the property's attributes container.

defaultItemValue()

virtual OdTfVariant OdTfProperty::defaultItemValue ( ) const

pure virtual

Retrieves the current default value for the property.

Returns

Returns the default value that should be used for the property instead of the OdTfVariant::kEmpty value.

Remarks

For a single property, the method returns a value that should be used instead of the whole property. For an array property, the method returns a value that replaces all empty items. Note that the default value can also be equal to OdTfVariant::kEmpty.

getValue()

virtual OdResult OdTfProperty::getValue ( const OdTfObject *  pObject, OdTfVariant &  value  ) const

pure virtual

Retrieves the current value of the property.

Parameters

pObject	[in] A pointer to an object that encapsulates the property.
value	[out] A placeholder for the value.

Returns

Returns the result of retrieving the property value.

Remarks

If the value was successfully returned to a calling subroutine, the method returns the eOk value; otherwise it returns an appropriate error code.

name()

virtual const OdString & OdTfProperty::name ( ) const

pure virtual

Retrieves the property name.

Returns

Returns the property's name represented as an OdString object.

owner()

virtual OdTfClass * OdTfProperty::owner ( ) const

pure virtual

Retrieves the owner class information for the property.

Returns

Returns a pointer to an OdTfClass object that owns the property.

setValue()

virtual OdResult OdTfProperty::setValue ( OdTfObject *  pObject, const OdTfVariant &  value  ) const

pure virtual

Sets a new value of the property.

Parameters

pObject	[in] A pointer to an object that encapsulates the property.
value	[out] A new value to be set.

Returns

Returns the result of setting the property value.

Remarks

If the value was successfully set to a calling subroutine, the method returns the eOk value; otherwise it returns an appropriate error code.

type()

virtual OdTfVariant::Type OdTfProperty::type ( ) const

pure virtual

Retrieves the property data type.

Returns

Returns the property's data type represented with the OdTfVariant::Type enumeration value.

---

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

• TfObject.h