CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OdRxRefersToAttribute Class Reference

#include <RxAttribute.h>

Inheritance diagram for OdRxRefersToAttribute:
OdRxAttribute OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxRefersToAttribute)
 
OdString path () const
 
- 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 &path)
 
static const OdRxPropertyBasePtr parseReference (const OdString &path, const OdRxObject *pObject, FindPropertyCallback find=NULL, ConvertValueCallback convert=NULL)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

 OdRxRefersToAttribute (OdRxRefersToAttributeImpl *)
 
- Protected Member Functions inherited from OdRxAttribute
 OdRxAttribute (OdRxAttributeImpl *)
 

Additional Inherited Members

- Protected Attributes inherited from OdRxAttribute
OdRxAttributeImplm_pImpl
 

Detailed Description

<group OdRx_Classes>

This attribute is used to provide additional information about properties linked with this one. Usually contained item with the container, like "/BlockTableId/Items" for OdDbEntity "BlockId" property.

Definition at line 446 of file RxAttribute.h.

Constructor & Destructor Documentation

◆ OdRxRefersToAttribute()

OdRxRefersToAttribute::OdRxRefersToAttribute ( OdRxRefersToAttributeImpl *  )
protected

Member Function Documentation

◆ createObject()

static OdRxAttributePtr OdRxRefersToAttribute::createObject ( const OdString path)
static

Constructor. Creates an attribute containing the provided path.

Parameters
path[in] Path to the related property (starting with database). E.g. "/BlockTableId/Items" for OdDbEntity "BlockId" property.
Returns
Smart pointer to a constructed attribute object.

◆ ODRX_DECLARE_MEMBERS()

OdRxRefersToAttribute::ODRX_DECLARE_MEMBERS ( OdRxRefersToAttribute  )

◆ parseReference()

static const OdRxPropertyBasePtr OdRxRefersToAttribute::parseReference ( const OdString path,
const OdRxObject pObject,
FindPropertyCallback  find = NULL,
ConvertValueCallback  convert = NULL 
)
static

Parses the reference path returning the last property. E.g. for "/BlockTableId/Items" it would be "Items" property of the block table.

Parameters
path[in] Path to the property. Intermediate names are separated by '/'. All the properties but the last should be dereferenceable (type().isReference() == true).
pObject[in] The object to start with. Usually database, for paths starting with '/'.
find[in] Optional callback to customize the property retrieval. OdRxMemberQueryEngine::find() is used by default.
convert[in] Optional callback to convert the property value to another type.
Returns
The last property in the path.

◆ path()

OdString OdRxRefersToAttribute::path ( ) const

Gets the path to the related property.

Returns
Path to the related property (starting with database). E.g. "/BlockTableId/Items" for OdDbEntity "BlockId" property.

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