CYIConditionEvaluator Class Reference

Detailed Description

Evaluates when CYICondition objects have been set, and notifies users.

Emits a CYIConditionEvaluator::Success signal when all of the CYICondition objects added to this CYIConditionEvaluator have been set, using CYICondition::Set().

Usage:

• Add CYICondition objects to a CYIConditionEvaluator
• Connect a slot to CYIConditionEvaluator::Success signal
• Call CYICondition::Set when each condition is true

See also

AddCondition

CYISignal::Connect

CYICondition::Set

#include <utility/YiCondition.h>

Inheritance diagram for CYIConditionEvaluator:

Public Member Functions
	CYIConditionEvaluator ()
virtual	~CYIConditionEvaluator ()
void	Reset ()
void	ClearConditions ()
void	AddCondition (CYICondition *pCondition)
Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()
	CYIScriptableObject (const CYIScriptableObject &other)
CYIScriptableObject &	operator= (const CYIScriptableObject &other)
virtual	~CYIScriptableObject ()
CYIBindingImplementation *	GetBindingImplementation () const
void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const

Public Attributes
CYISignal	Success

Friends
class	CYICondition

Constructor & Destructor Documentation

CYIConditionEvaluator::CYIConditionEvaluator

(

)

virtual CYIConditionEvaluator::~CYIConditionEvaluator ( )

virtual

Member Function Documentation

void CYIConditionEvaluator::AddCondition

(

CYICondition *

pCondition

)

Adds a new condition to be evaluated. The CYIConditionEvaluator does not take ownership of pCondition.

Warning

CYICondition objects should not be added to more than one CYIConditionEvaluator.

void CYIConditionEvaluator::ClearConditions

(

)

Remove all CYICondition objects added to this CYIConditionEvaluator.

See also

AddCondition

void CYIConditionEvaluator::Reset

(

)

Unset each CYICondition added to this CYIConditionEvaluator. Reset() is automatically called after the CYIConditionEvaluator::Success signal is fired.

Friends And Related Function Documentation

friend class CYICondition

friend

Member Data Documentation

CYISignal CYIConditionEvaluator::Success

Emitted when all conditions are true. Conditions are automatically evaluated when CYICondition::Set is called.

---

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

• utility/YiCondition.h