DtVrfObjectPredicateEvaluator Class Reference

class DtVrfObjectPredicateEvaluator: More...

List of all members.

Public Member Functions
	DtVrfObjectPredicateEvaluator ()
	default constructor
	DtVrfObjectPredicateEvaluator (const DtVrfObjectPredicate &predicate)
	constructor with predicate supplied
virtual	~DtVrfObjectPredicateEvaluator ()
	destructor
	DtVrfObjectPredicateEvaluator (const DtVrfObjectPredicateEvaluator &orig)
	copy constructor
DtVrfObjectPredicateEvaluator &	operator= (const DtVrfObjectPredicateEvaluator &orig)
	assignment operator
virtual DtVrfObjectPredicateEvaluator *	clone () const
	clone function
int	operator== (const DtVrfObjectPredicateEvaluator &orig) const
	equality operators for comparing predicate evaluators
int	operator!= (const DtVrfObjectPredicateEvaluator &orig) const
virtual bool	isTrue (const DtVrfObject *vrfObject) const
	This function evaluates the supplied predicate.
virtual void	setPredicate (const DtVrfObjectPredicate &predicate)
	Set/get the predicate to use. This makes a local copy of the predicate.
virtual const DtVrfObjectPredicate *	predicate () const
virtual void	setTestInterval (DtTime intervalInSeconds)
	Set/get the time interval to take between tests.
virtual DtTime	testInterval () const
virtual bool	isTimeToTest () const
	Returns true if the time since our last call to isTrue() exceeds the the test interval time period.
virtual DtClock *	clock () const
	Get/Set the clock being used for establishing the rate at which isTrue() tests should be performed.
virtual void	setClock (DtClock *clock)
Protected Attributes
DtVrfObjectPredicate *	myPredicate
	This is the predicate to evaluate.
DtTime	myTimeToNextTest
	The time until our next isTrue() test may be performed.
DtTime	myTestInterval
	Time interval between tests. By default, the interval is 0,.
DtClock *	myClock
	The clock being used for establishing the rate at which isTrue() tests should be performed.

---

Detailed Description

class DtVrfObjectPredicateEvaluator:

Instances of DtVrfObjectPredicateEvaluator are used to evaluate a DtVrfObjectPredicate at some regular interval.

---

Constructor & Destructor Documentation

DtVrfObjectPredicateEvaluator::DtVrfObjectPredicateEvaluator

(

)

default constructor

DtVrfObjectPredicateEvaluator::DtVrfObjectPredicateEvaluator

(

const DtVrfObjectPredicate &

predicate

)

constructor with predicate supplied

virtual DtVrfObjectPredicateEvaluator::~DtVrfObjectPredicateEvaluator

(

)

[virtual]

destructor

DtVrfObjectPredicateEvaluator::DtVrfObjectPredicateEvaluator

(

const DtVrfObjectPredicateEvaluator &

orig

)

copy constructor

---

Member Function Documentation

DtVrfObjectPredicateEvaluator& DtVrfObjectPredicateEvaluator::operator=

(

const DtVrfObjectPredicateEvaluator &

orig

)

assignment operator

virtual DtVrfObjectPredicateEvaluator* DtVrfObjectPredicateEvaluator::clone

(

)

const [virtual]

clone function

int DtVrfObjectPredicateEvaluator::operator==

(

const DtVrfObjectPredicateEvaluator &

orig

)

const

equality operators for comparing predicate evaluators

int DtVrfObjectPredicateEvaluator::operator!=

(

const DtVrfObjectPredicateEvaluator &

orig

)

const

virtual bool DtVrfObjectPredicateEvaluator::isTrue

(

const DtVrfObject *

vrfObject

)

const [virtual]

This function evaluates the supplied predicate.

virtual void DtVrfObjectPredicateEvaluator::setPredicate

(

const DtVrfObjectPredicate &

predicate

)

[virtual]

Set/get the predicate to use. This makes a local copy of the predicate.

virtual const DtVrfObjectPredicate* DtVrfObjectPredicateEvaluator::predicate

(

)

const [virtual]

virtual void DtVrfObjectPredicateEvaluator::setTestInterval

(

DtTime

intervalInSeconds

)

[virtual]

Set/get the time interval to take between tests.

This is the time that should be taken between successive calls to isTrue(). By default, the test interval is 0.0 (every call to isTimeToTest() will return true). If you call setTestInterval() to set the time interval to a non-zero value, make sure that you also set the clock.

virtual DtTime DtVrfObjectPredicateEvaluator::testInterval

(

)

const [virtual]

virtual bool DtVrfObjectPredicateEvaluator::isTimeToTest

(

)

const [virtual]

Returns true if the time since our last call to isTrue() exceeds the the test interval time period.

virtual DtClock* DtVrfObjectPredicateEvaluator::clock

(

)

const [virtual]

Get/Set the clock being used for establishing the rate at which isTrue() tests should be performed.

If you call setTestInterval() to to set a non-zero interval at which isTrue() should be called, then you must have a valid pointer to a clock.

virtual void DtVrfObjectPredicateEvaluator::setClock

(

DtClock *

clock

)

[virtual]

---

Member Data Documentation

DtVrfObjectPredicate* DtVrfObjectPredicateEvaluator::myPredicate [protected]

This is the predicate to evaluate.

DtTime DtVrfObjectPredicateEvaluator::myTimeToNextTest [protected]

The time until our next isTrue() test may be performed.

DtTime DtVrfObjectPredicateEvaluator::myTestInterval [protected]

Time interval between tests. By default, the interval is 0,.

DtClock* DtVrfObjectPredicateEvaluator::myClock [protected]

The clock being used for establishing the rate at which isTrue() tests should be performed.

---

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

• include/vrfobjcore/vrfObjPredEval.h