AECPropertyExtensionBase Class Reference

#include <AECPropertyExtensionBase.h>

Inheritance diagram for AECPropertyExtensionBase:

Public Member Functions
virtual AECVariant	GetAutomaticProperty (OdDbObject *pObject, const OdString &strPropertyName, const OdDbObjectId &idDataFormat=OdDbObjectId::kNull)=0
AECVariant	GetProperty (OdDbObject *pObject, const OdDbObjectId &idPropertySetDef, OdUInt32 iPropertyIndex, const OdDbObjectId &idDataFormat=OdDbObjectId::kNull, AECVariant *pRawValue=0)
AECVariant	GetProperty (OdDbObject *pObject, const OdDbObjectId &idPropertySetDef, const OdString &strPropertyName, const OdDbObjectId &idDataFormat=OdDbObjectId::kNull, AECVariant *pRawValue=0)
AECVariant	GetProperty (OdDbObject *pObject, AECPropertyDefPtr pPropertyDef, const OdDbObjectId &idDataFormat=OdDbObjectId::kNull, AECVariant *pRawValue=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

Static Public Member Functions
static void	GetPropertyNames (OdRxClass *pDesc, std::vector< OdString > &aNames)
static void	GetQueryInfos (OdRxClass *pDesc, std::vector< AECQueryInfo > &aQueryInfos)
static bool	GetQueryInfoByPropertyName (OdRxClass *pDesc, const OdString &strName, AECQueryInfo &cQueryInfo)
static bool	GetQueryInfoByPropertyIndex (OdRxClass *pDesc, OdUInt32 iIndex, AECQueryInfo &cQueryInfo)
static OdDbObjectId	GetPropertySet (OdDbObject *pObject, const OdDbObjectId &idPropertySetDef, bool bCreateIfNotFound=false)
static void	RemovePropertySet (OdDbObject *pObject, const OdDbObjectId &idPropertySetDef)
static OdDbObjectId	GetReferencePropertySet (const OdDbObjectId &idReference, const AECSmartReference &rRef, const OdDbObjectId &idPropertySetDef, bool bCreateIfNotFound=false)
static void	RemoveReferencePropertySet (const OdDbObjectId &idReference, const AECSmartReference &rRef, const OdDbObjectId &idPropertySetDef)
static AECVariant	GetReferenceProperty (const OdDbObjectId &idReference, const AECSmartReference &rRef, const OdDbObjectId &idPropertySetDef, OdUInt32 iPropertyIndex, const OdDbObjectId &idDataFormat=OdDbObjectId::kNull, AECVariant *pRawValue=0)
static AECVariant	GetReferenceProperty (const OdDbObjectId &idReference, const AECSmartReference &rRef, const OdDbObjectId &idPropertySetDef, const OdString &strPropertyName, const OdDbObjectId &idDataFormat=OdDbObjectId::kNull, AECVariant *pRawValue=0)
static OdDbObjectId	GetPropertySetOverrideContainer (const OdDbObjectId &idReference, bool bCreateIfNotFound=false)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

Protocol extension class that allows access to object`s collection of Property Sets.

Remarks

Either gives access to extension dictionary with Property Sets in case of entity of style. Or gives access to Property Set Override Container in case of block reference of XRef.

<group TA_Other_Classes>

Definition at line 43 of file AECPropertyExtensionBase.h.

Member Function Documentation

GetAutomaticProperty()

virtual AECVariant AECPropertyExtensionBase::GetAutomaticProperty ( OdDbObject *  pObject, const OdString &  strPropertyName, const OdDbObjectId &  idDataFormat = OdDbObjectId::kNull  )

pure virtual

Returns formatted automatic property value.

Parameters

pObject	[in] Object that is queried.
strPropertyName	[in] Property name.
idDataFormat	[in] Schedule Data Format to use for formatting. If null formatting is not applied.

Returns

Property value.

GetProperty() [1/3]

AECVariant AECPropertyExtensionBase::GetProperty	(	OdDbObject *	pObject,
		AECPropertyDefPtr	pPropertyDef,
		const OdDbObjectId &	idDataFormat = OdDbObjectId::kNull,
		AECVariant *	pRawValue = 0
	)

GetProperty() [2/3]

AECVariant AECPropertyExtensionBase::GetProperty	(	OdDbObject *	pObject,
		const OdDbObjectId &	idPropertySetDef,
		const OdString &	strPropertyName,
		const OdDbObjectId &	idDataFormat = OdDbObjectId::kNull,
		AECVariant *	pRawValue = 0
	)

Returns property value.

Parameters

pObject	[in] Object that is queried.
idPropertySet	[in] Property Set Definition.
iPropertyIndex	[in] Property index.
idDataFormat	[in] Schedule Data Format to use for formatting. If null formatting is not applied.

Returns

Property name.

GetProperty() [3/3]

AECVariant AECPropertyExtensionBase::GetProperty	(	OdDbObject *	pObject,
		const OdDbObjectId &	idPropertySetDef,
		OdUInt32	iPropertyIndex,
		const OdDbObjectId &	idDataFormat = OdDbObjectId::kNull,
		AECVariant *	pRawValue = 0
	)

Returns property value.

Parameters

pObject	[in] Object that is queried.
idPropertySet	[in] Property Set Definition.
iPropertyIndex	[in] Property index.
idDataFormat	[in] Schedule Data Format to use for formatting. If null formatting is not applied.

Returns

Property value.

GetPropertyNames()

static void AECPropertyExtensionBase::GetPropertyNames ( OdRxClass *  pDesc, std::vector< OdString > &  aNames  )

static

Returns the array of automatic property names for specified entity type.

Parameters

pDesc	[in] Type of object.
aNames	[out] Array of property names.

GetPropertySet()

static OdDbObjectId AECPropertyExtensionBase::GetPropertySet ( OdDbObject *  pObject, const OdDbObjectId &  idPropertySetDef, bool  bCreateIfNotFound = false  )

static

Returns Property Set corresponding to the specified Property Set Definition.

Parameters

pObject	[in] Object that is queried for Property Set.
idPropertySetDef	[in] Object ID of Property Set Definition.
bCreateIfNotFound	[in] Whether property set should be created if it was not found.

Returns

Object ID of Property Set. If Property Set was not found method silently returns OdDbObjectId::kNull.

GetPropertySetOverrideContainer()

static OdDbObjectId AECPropertyExtensionBase::GetPropertySetOverrideContainer ( const OdDbObjectId &  idReference, bool  bCreateIfNotFound = false  )

static

Returns Property Set Override container for specified object.

Parameters

idReference

[in] Object ID of Block Reference object.

Remarks

Only works on objects of OdDbBlockReference type.

GetQueryInfoByPropertyIndex()

static bool AECPropertyExtensionBase::GetQueryInfoByPropertyIndex ( OdRxClass *  pDesc, OdUInt32  iIndex, AECQueryInfo &  cQueryInfo  )

static

GetQueryInfoByPropertyName()

static bool AECPropertyExtensionBase::GetQueryInfoByPropertyName ( OdRxClass *  pDesc, const OdString &  strName, AECQueryInfo &  cQueryInfo  )

static

Returns query information for automatic property with specified name.

Parameters

pDesc	[in] Type of object.
strName	[in] Property name.
cQueryInfo	[out] Query information.

Returns

True in case of success.

GetQueryInfos()

static void AECPropertyExtensionBase::GetQueryInfos ( OdRxClass *  pDesc, std::vector< AECQueryInfo > &  aQueryInfos  )

static

Returns the array of query informations for all automatic properties.

Parameters

pDesc	[in] Type of object.
aQueryInfos	[out] Array of query information.

GetReferenceProperty() [1/2]

static AECVariant AECPropertyExtensionBase::GetReferenceProperty ( const OdDbObjectId &  idReference, const AECSmartReference &  rRef, const OdDbObjectId &  idPropertySetDef, const OdString &  strPropertyName, const OdDbObjectId &  idDataFormat = OdDbObjectId::kNull, AECVariant *  pRawValue = 0  )

static

Returns property value for entity inside block reference.

GetReferenceProperty() [2/2]

static AECVariant AECPropertyExtensionBase::GetReferenceProperty ( const OdDbObjectId &  idReference, const AECSmartReference &  rRef, const OdDbObjectId &  idPropertySetDef, OdUInt32  iPropertyIndex, const OdDbObjectId &  idDataFormat = OdDbObjectId::kNull, AECVariant *  pRawValue = 0  )

static

Returns property value for entity inside block reference.

GetReferencePropertySet()

static OdDbObjectId AECPropertyExtensionBase::GetReferencePropertySet ( const OdDbObjectId &  idReference, const AECSmartReference &  rRef, const OdDbObjectId &  idPropertySetDef, bool  bCreateIfNotFound = false  )

static

Creates Property Set corresponding to the specified Property Set Definition.

Parameters

idReference	[in] Block reference.
rRef	[in] Smart reference to object inside.
idPropertySetDef	[in] Property Set Definition to override.
bCreateIfNotFound	[in] Whether property set should be created if it was not found.

Returns

Property Set.

RemovePropertySet()

static void AECPropertyExtensionBase::RemovePropertySet ( OdDbObject *  pObject, const OdDbObjectId &  idPropertySetDef  )

static

Removes Property Set corresponding to the specified Property Set Definition.

Parameters

pObject	[in] Object that is queried for Property Set.
idPropertySetDef	[in] Object ID of Property Set Definition.

RemoveReferencePropertySet()

static void AECPropertyExtensionBase::RemoveReferencePropertySet ( const OdDbObjectId &  idReference, const AECSmartReference &  rRef, const OdDbObjectId &  idPropertySetDef  )

static

Removes Property Set corresponding to the specified Property Set Definition.

Parameters

idReference	[in] Block reference.
rRef	[in] Smart reference to object inside.
idPropertySetDef	[in] Object ID of Property Set Definition.

---

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

• AECPropertyExtensionBase.h