OdDbDynBlockReferenceProperty Class Reference

#include <DbDynBlockReference.h>

Inheritance diagram for OdDbDynBlockReferenceProperty:

Public Types
enum	UnitsType { kNoUnits = 0, kAngular = 1, kDistance = 2, kArea = 3 }

Public Member Functions
	OdDbDynBlockReferenceProperty ()
virtual	~OdDbDynBlockReferenceProperty ()
	OdDbDynBlockReferenceProperty (const OdDbDynBlockReferenceProperty &other)
OdDbDynBlockReferenceProperty &	operator= (const OdDbDynBlockReferenceProperty &other)
OdDbObjectId	blockId () const
OdString	propertyName () const
OdResBuf::ValueType	propertyType () const
bool	readOnly () const
bool	show () const
bool	visibleInCurrentVisibilityState () const
OdString	description () const
UnitsType	unitsType () const
void	getAllowedValues (OdResBufArray &allowedValues)
OdResBufPtr	value () const
bool	setValue (const OdResBufPtr &value)
OdDbBlockParameterPtr	getParameter ()
void	getDescriptor (OdDbEvalNodeId &parameterId, OdDbBlkParamPropertyDescriptor &pDescriptor)
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

Friends
class	OdDbDynBlockReferencePropertyImpl

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

Detailed Description

This class is a utility class referencing properties of dynamic blocks.

Remarks

Corresponding C++ library: TD_DynBlocks <group OdDb_Classes>

Definition at line 52 of file DbDynBlockReference.h.

Member Enumeration Documentation

UnitsType

enum OdDbDynBlockReferenceProperty::UnitsType

Enumerator
kNoUnits
kAngular
kDistance
kArea

Definition at line 56 of file DbDynBlockReference.h.

Constructor & Destructor Documentation

OdDbDynBlockReferenceProperty() [1/2]

OdDbDynBlockReferenceProperty::OdDbDynBlockReferenceProperty

(

)

~OdDbDynBlockReferenceProperty()

virtual OdDbDynBlockReferenceProperty::~OdDbDynBlockReferenceProperty ( )

virtual

OdDbDynBlockReferenceProperty() [2/2]

OdDbDynBlockReferenceProperty::OdDbDynBlockReferenceProperty

(

const OdDbDynBlockReferenceProperty &

other

)

Parameters

other

[in] Constant reference to the dynamic block reference property.

Member Function Documentation

blockId()

OdDbObjectId OdDbDynBlockReferenceProperty::blockId

(

)

const

Returns the Object ID of the dynamic block reference that owns this property.

description()

OdString OdDbDynBlockReferenceProperty::description

(

)

const

Returns the description of this property.

getAllowedValues()

void OdDbDynBlockReferenceProperty::getAllowedValues

(

OdResBufArray &

allowedValues

)

Returns an array of allowed values for this property.

Parameters

allowedValues

[out] Receives an an array of allowed values.

getDescriptor()

void OdDbDynBlockReferenceProperty::getDescriptor	(	OdDbEvalNodeId &	parameterId,
		OdDbBlkParamPropertyDescriptor &	pDescriptor
	)

Returns a parameter descriptor.

Parameters

parameterId	[out] Parameter ID.
pDescriptor	[out] Parameter descriptor.

getParameter()

OdDbBlockParameterPtr OdDbDynBlockReferenceProperty::getParameter

(

)

Returns a parameter smart pointer.

operator=()

OdDbDynBlockReferenceProperty& OdDbDynBlockReferenceProperty::operator=

(

const OdDbDynBlockReferenceProperty &

other

)

propertyName()

OdString OdDbDynBlockReferenceProperty::propertyName

(

)

const

Returns the name of this property.

Remarks

All property names in a given block reference are guaranteed unique.

propertyType()

OdResBuf::ValueType OdDbDynBlockReferenceProperty::propertyType

(

)

const

Returns the type of the property value.

readOnly()

bool OdDbDynBlockReferenceProperty::readOnly

(

)

const

Returns true if and only if this property is Read-Only.

setValue()

bool OdDbDynBlockReferenceProperty::setValue

(

const OdResBufPtr &

value

)

Sets the current value of the property on the dynamic block reference.

Parameters

value

[in] Value.

Returns

Returns true if and only if successful.

show()

bool OdDbDynBlockReferenceProperty::show

(

)

const

Returns true if and only if this property is displayed on the Property Palette.

unitsType()

UnitsType OdDbDynBlockReferenceProperty::unitsType

(

)

const

Returns the units of this property.

Remarks

This function may be used to format property values.

unitsType() returns one of the following:

Value Description kNoUnits 0 No units defined. kAngular 1 Angle. kDistance 2 Distance. kArea 3 2D area.

value()

OdResBufPtr OdDbDynBlockReferenceProperty::value

(

)

const

Returns the current value of the property on the dynamic block reference.

visibleInCurrentVisibilityState()

bool OdDbDynBlockReferenceProperty::visibleInCurrentVisibilityState

(

)

const

Returns true if and only if this property is visible in the current visibility state.

Friends And Related Function Documentation

OdDbDynBlockReferencePropertyImpl

friend class OdDbDynBlockReferencePropertyImpl

friend

Definition at line 164 of file DbDynBlockReference.h.

---

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

• DbDynBlockReference.h