CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OdRxMemberQueryContext Class Referenceabstract

#include <RxMember.h>

Inheritance diagram for OdRxMemberQueryContext:
OdRxObject OdRxPromotingQueryContext

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxMemberQueryContext)
 
OdRxMemberIteratorPtr newMemberIterator (const OdArray< OdRxClassPtr > &facets) const
 
virtual OdRxMemberPtr find (const OdArray< OdRxClassPtr > &facets, const OdChar *name) const
 
- 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
 

Protected Member Functions

 OdRxMemberQueryContext ()
 
virtual ~OdRxMemberQueryContext ()
 
virtual OdRxMemberIteratorPtr subNewMemberIterator (const OdArray< OdRxClassPtr > &facets) const =0
 

Protected Attributes

OdRxMemberQueryContextImplm_pImpl
 

Friends

class OdRxMemberQueryContextImpl
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group OdRx_Classes>

Class that makes a list of members for the iterator. It is called by the engine with a list of the facets it has collected. Facets include the object class. It is up to the context to check the class parents.

Definition at line 375 of file RxMember.h.

Constructor & Destructor Documentation

◆ OdRxMemberQueryContext()

OdRxMemberQueryContext::OdRxMemberQueryContext ( )
protected

◆ ~OdRxMemberQueryContext()

virtual OdRxMemberQueryContext::~OdRxMemberQueryContext ( )
protectedvirtual

Member Function Documentation

◆ find()

virtual OdRxMemberPtr OdRxMemberQueryContext::find ( const OdArray< OdRxClassPtr > &  facets,
const OdChar name 
) const
virtual

Gets the pointer to the member of the class by name.

Parameters
facets[in] Array of objects.
name[in] The pointer to the name of member to be found.
Returns
Pointer to the member if it was found; NULL otherwise.

◆ newMemberIterator()

OdRxMemberIteratorPtr OdRxMemberQueryContext::newMemberIterator ( const OdArray< OdRxClassPtr > &  facets) const

Builds an iterator listing all the members of these classes (optionally including members of parents and children of members). Parameters are called "facets", because they can include "extension" classes.

Parameters
facets[in] Array of objects.
Returns
Pointer to the iterator of the members of the specified objects.

◆ ODRX_DECLARE_MEMBERS()

OdRxMemberQueryContext::ODRX_DECLARE_MEMBERS ( OdRxMemberQueryContext  )

◆ subNewMemberIterator()

virtual OdRxMemberIteratorPtr OdRxMemberQueryContext::subNewMemberIterator ( const OdArray< OdRxClassPtr > &  facets) const
protectedpure virtual

Friends And Related Function Documentation

◆ OdRxMemberQueryContextImpl

friend class OdRxMemberQueryContextImpl
friend

Definition at line 406 of file RxMember.h.

Member Data Documentation

◆ m_pImpl

OdRxMemberQueryContextImpl* OdRxMemberQueryContext::m_pImpl
protected

Definition at line 407 of file RxMember.h.


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