OdRxMemberQueryEngine Class Reference

#include <RxMember.h>

Public Member Functions
OdRxMemberPtr	find (const OdRxObject *pO, const OdChar *name, const OdRxMemberQueryContext *pContext=NULL, bool bQueryFacets=true) const
OdRxMemberIteratorPtr	newMemberIterator (const OdRxObject *pO, const OdRxMemberQueryContext *pContext=NULL) const
const OdRxMemberQueryContext *	defaultContext () const
const OdRxPromotingQueryContext *	promotingContext () const
void	addFacetProvider (OdRxFacetProvider *pProvider)
void	removeFacetProvider (OdRxFacetProvider *pProvider)
void	addReactor (OdRxMemberReactor *pReactor)
void	removeReactor (OdRxMemberReactor *pReactor)

Static Public Member Functions
static OdRxMemberQueryEngine *	theEngine ()

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 468 of file RxMember.h.

Member Function Documentation

addFacetProvider()

void OdRxMemberQueryEngine::addFacetProvider

(

OdRxFacetProvider *

pProvider

)

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

Parameters

pProvider

[in] Facet provider to be registered.

addReactor()

void OdRxMemberQueryEngine::addReactor

(

OdRxMemberReactor *

pReactor

)

Registers a new reactor.

Parameters

pReactor

[in] Reactor to be registered.

defaultContext()

const OdRxMemberQueryContext * OdRxMemberQueryEngine::defaultContext

(

)

const

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

Returns

Query context.

find()

OdRxMemberPtr OdRxMemberQueryEngine::find	(	const OdRxObject *	pO,
		const OdChar *	name,
		const OdRxMemberQueryContext *	pContext = NULL,
		bool	bQueryFacets = true
	)		const

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

Parameters

pO	[in] Object to search the member in.
name	[in] Name of the member to be found.
pContext	[in] Context. Optional.
bQueryFacets	[in] Flag determines if the function will query members added dynamically by facet providers. Default value is true.

Returns

Pointer to the found member.

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.

Parameters

pO	[in] Object to enumerate the properties of.
pContext	[in] Context. Optional.

Returns

Pointer to the iterator of the enumerated properties.

promotingContext()

const OdRxPromotingQueryContext * OdRxMemberQueryEngine::promotingContext

(

)

const

Reference to the default promoting query context. Handles collecting members in a list, but unlike the default, this 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.

Returns

Promoting query context.

removeFacetProvider()

void OdRxMemberQueryEngine::removeFacetProvider

(

OdRxFacetProvider *

pProvider

)

Unregisters an extension provider.

Parameters

pProvider

[in] Facet provider to be removed.

removeReactor()

void OdRxMemberQueryEngine::removeReactor

(

OdRxMemberReactor *

pReactor

)

Unregisters a reactor.

Parameters

pReactor

[in] Reactor to be removed.

theEngine()

static OdRxMemberQueryEngine * OdRxMemberQueryEngine::theEngine ( )

static

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

Returns

The member engine services access point object.

Friends And Related Function Documentation

OdRxMemberQueryEngineImpl

friend class OdRxMemberQueryEngineImpl

friend

Definition at line 558 of file RxMember.h.

---

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

• RxMember.h