OdFdFieldEngine Class Reference

#include <FdField.h>

Inheritance diagram for OdFdFieldEngine:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdFdFieldEngine)
virtual	~OdFdFieldEngine ()
virtual void	registerEvaluatorLoader (OdFdFieldEvaluatorLoader *pLoader)=0
virtual void	unregisterEvaluatorLoader (OdFdFieldEvaluatorLoader *pLoader)=0
virtual int	evaluatorLoaderCount () const =0
virtual OdFdFieldEvaluatorLoader *	getEvaluatorLoader (int inputIndex)=0
virtual OdFdFieldEvaluator *	getEvaluator (const OdString &pszEvalId)=0
virtual OdFdFieldEvaluator *	findEvaluator (OdDbField *pField, OdString &pszEvalId)=0
virtual void	addFieldReactor (OdFdFieldReactor *pReactor)=0
virtual void	removeFieldReactor (OdFdFieldReactor *pReactor)=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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class manages the evaluation of fields.

Remarks

The field engine is a global one-per-session object.

The field evaluators should register their loader with the engine during application startup <group Other_Classes>

Definition at line 236 of file FdField.h.

Constructor & Destructor Documentation

~OdFdFieldEngine()

virtual OdFdFieldEngine::~OdFdFieldEngine ( )

inlinevirtual

Definition at line 240 of file FdField.h.

Member Function Documentation

addFieldReactor()

virtual void OdFdFieldEngine::addFieldReactor ( OdFdFieldReactor *  pReactor )

pure virtual

Adds the field reactor to the field framework.

Parameters

pReactor

[in] Input pointer to the reactor to be added

evaluatorLoaderCount()

virtual int OdFdFieldEngine::evaluatorLoaderCount ( ) const

pure virtual

Returns the number of registered field evaluator loaders.

findEvaluator()

virtual OdFdFieldEvaluator* OdFdFieldEngine::findEvaluator ( OdDbField *  pField, OdString &  pszEvalId  )

pure virtual

Returns an an evaluator for the specified field from the set of registered evaluators if the field does not have an evaluator ID.

Parameters

pField	[in] Input field for which to find an evaluator
pszEvalId	[out] Output pointer to receive the evaluator ID

Returns

Returns the field evaluator for the specified field, or null if a field evaluator could not be found.

getEvaluator()

virtual OdFdFieldEvaluator* OdFdFieldEngine::getEvaluator ( const OdString &  pszEvalId )

pure virtual

Returns the field evaluator for the specified evaluator ID.

Returns

Returns null if a field evaluator could not be found for the evaluator ID.

Parameters

pszEvalId

[in] Input evaluator ID for which to find the field evaluator

getEvaluatorLoader()

virtual OdFdFieldEvaluatorLoader* OdFdFieldEngine::getEvaluatorLoader ( int  inputIndex )

pure virtual

Returns the field evaluator loader at the specified index.

Remarks

This function can be used with evaluatorLoaderCount() to enumerate the evaluator loaders.

Parameters

inputIndex

[in] Input index for which to get the field evaluator loader; the index is zero based and should be less than the number of registered evaluator loaders.

ODRX_DECLARE_MEMBERS()

OdFdFieldEngine::ODRX_DECLARE_MEMBERS

(

OdFdFieldEngine

)

registerEvaluatorLoader()

virtual void OdFdFieldEngine::registerEvaluatorLoader ( OdFdFieldEvaluatorLoader *  pLoader )

pure virtual

Registers the evaluator loader with the engine.

Remarks

The engine searches the registered evaluator loaders to find the appropriate evaluator for evaluating fields. Field evaluators should register the evaluator loader with the field engine during application startup.

Parameters

pLoader

[in] Input evaluator loader to register

removeFieldReactor()

virtual void OdFdFieldEngine::removeFieldReactor ( OdFdFieldReactor *  pReactor )

pure virtual

Removes the field reactor from the field framework.

Parameters

pReactor

[in] Input pointer to field reactor to remove

unregisterEvaluatorLoader()

virtual void OdFdFieldEngine::unregisterEvaluatorLoader ( OdFdFieldEvaluatorLoader *  pLoader )

pure virtual

Unregisters the evaluator loader from the engine.

Remarks

Field evaluator modules should unregister the evaluator loader when the module is unloaded, before deleting the loader object.

Parameters

pLoader

[in] Input evaluator loader to unregister

---

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

• FdField.h