CFx SDK Documentation  2023 SP0
Public Member Functions | Static Public Member Functions | Friends | List of all members
OdRxMemberQueryEngine Class Reference

#include <RxMember.h>

Public Member Functions

OdRxMemberfind (const OdRxObject *pO, const OdChar *name, const OdRxMemberQueryContext *pContext=NULL) const
 
OdRxMemberIteratorPtr newMemberIterator (const OdRxObject *pO, const OdRxMemberQueryContext *pContext=NULL) const
 
const OdRxMemberQueryContextdefaultContext () const
 
const OdRxPromotingQueryContextpromotingContext () const
 
void addFacetProvider (OdRxFacetProvider *pProvider)
 
void removeFacetProvider (OdRxFacetProvider *pProvider)
 
void addReactor (OdRxMemberReactor *pReactor)
 
void removeReactor (OdRxMemberReactor *pReactor)
 

Static Public Member Functions

static OdRxMemberQueryEnginetheEngine ()
 

Friends

class OdRxMemberQueryEngineImpl
 

Detailed Description

<group OdRx_Classes> This class provides ability to enumerate and find members associated with the given object, add new property providers (OdRxFacetProvider) and reactors.

Definition at line 293 of file RxMember.h.

Member Function Documentation

◆ addFacetProvider()

void OdRxMemberQueryEngine::addFacetProvider ( OdRxFacetProvider pProvider)

Register new facet provider (to provide extension classes with additional members).

◆ addReactor()

void OdRxMemberQueryEngine::addReactor ( OdRxMemberReactor pReactor)

Register new reactor.

◆ defaultContext()

const OdRxMemberQueryContext* OdRxMemberQueryEngine::defaultContext ( ) const

Reference to the default query context. Query context handles collecting members in a list.

◆ find()

OdRxMember* OdRxMemberQueryEngine::find ( const OdRxObject pO,
const OdChar name,
const OdRxMemberQueryContext pContext = NULL 
) const

Finds member by name, uses defaultContext() if no context is passed

◆ newMemberIterator()

OdRxMemberIteratorPtr OdRxMemberQueryEngine::newMemberIterator ( const OdRxObject pO,
const OdRxMemberQueryContext pContext = NULL 
) const

Enumerates all the properties of the object, uses defaultContext() if no context is passed

◆ promotingContext()

const OdRxPromotingQueryContext* OdRxMemberQueryEngine::promotingContext ( ) const

Reference to the default promoting query context. Handles collecting members in a list, but unlike default one, includes children (sub-properties) in the list, instead of parents. For example OdDbLine property "EndPoint" would be replaced by "EndPoint/X", "EndPoint/Y", "EndPoint/Z" if queried using this context.

◆ removeFacetProvider()

void OdRxMemberQueryEngine::removeFacetProvider ( OdRxFacetProvider pProvider)

Unregister extension provider.

◆ removeReactor()

void OdRxMemberQueryEngine::removeReactor ( OdRxMemberReactor pReactor)

Unregister reactor.

◆ theEngine()

static OdRxMemberQueryEngine* OdRxMemberQueryEngine::theEngine ( )
static

This singleton object is the main access point to the member engine services.

Friends And Related Function Documentation

◆ OdRxMemberQueryEngineImpl

friend class OdRxMemberQueryEngineImpl
friend

Definition at line 344 of file RxMember.h.


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