DtCompositePredicate Class Reference

Contains the DtCompositePredicate class declaration. More...

Inheritance diagram for DtCompositePredicate:

Public Member Functions
	DtCompositePredicate (bool negate=false)
	default constructor More...
virtual	~DtCompositePredicate ()
	destructor More...
	DtCompositePredicate (const DtCompositePredicate &orig)
	copy constructor More...
DtCompositePredicate &	operator= (const DtCompositePredicate &orig)
	assignment operator More...
virtual DtVrfObjectPredicate *	clone () const
	clone function More...
virtual void	addPredicate (const DtVrfObjectPredicate &predicate)
	adds a sub-predicate More...
virtual void	removePredicate (const DtVrfObjectPredicate &predicate)
	removes a force type from the set of types to be checked More...
virtual bool	hasPredicate (const DtVrfObjectPredicate &predicate) const
	returns true if the predicate is in the predicate list More...
Public Member Functions inherited from DtVrfObjectPredicate
	DtVrfObjectPredicate (bool negate=false)
	constructor More...
virtual	~DtVrfObjectPredicate ()
	destructor More...
	DtVrfObjectPredicate (const DtVrfObjectPredicate &orig)
	copy constructor More...
DtVrfObjectPredicate &	operator= (const DtVrfObjectPredicate &orig)
	assignment operator More...
bool	operator== (const DtVrfObjectPredicate &orig) const
	Equality operators used to compare predicates. More...
bool	operator!= (const DtVrfObjectPredicate &orig) const
virtual bool	negated () const
virtual void	setNegate (bool negate)
bool	isTrue (const DtVrfObject *vrfObject)
	This function evaluates the eval function (to be defined in derived classes) given a DtVrfObject and returns the result, negated if indicated. More...
virtual bool	canBeTrue (const DtVrfObject *vrfObject)
virtual bool	canBeFalse (const DtVrfObject *vrfObject)
virtual void	stringRep (std::ostream &str, int indentLevel=0) const

Protected Member Functions
virtual bool	eval (const DtVrfObject *object)
	The actual test this predicate performs. More...
virtual bool	predicateEqual (const DtVrfObjectPredicate &orig) const
	Used by equality operator used to compare predicates. More...
virtual bool	canEvalTrue (const DtVrfObject *vrfObject)
virtual bool	canEvalFalse (const DtVrfObject *vrfObject)
virtual void	typeSpecificStringRep (std::ostream &str, int indentLevel) const
	Override in specific subclasses to print the predicate description to the stream. More...

Protected Attributes
DtList	myPredicates
Protected Attributes inherited from DtVrfObjectPredicate
bool	myNegated

Additional Inherited Members
Static Public Member Functions inherited from DtVrfObjectPredicate
static const DtVrfObjectPredicate &	nullPredicate ()
	Returns an instance of a DtNullVrfObjectPredicate. More...

Detailed Description

Contains the DtCompositePredicate class declaration.

Instances of DtCompositePredicate maintain and evaluate a list of sub-predicates. An object will not pass an eval unless it passes the evals of all the predicates. Instances of DtCompositePredicate are not considered equal unless their predicate lists match.

Constructor & Destructor Documentation

DtCompositePredicate::DtCompositePredicate

(

bool

negate = false

)

default constructor

virtual DtCompositePredicate::~DtCompositePredicate ( )

virtual

destructor

DtCompositePredicate::DtCompositePredicate

(

const DtCompositePredicate &

orig

)

copy constructor

Member Function Documentation

DtCompositePredicate& DtCompositePredicate::operator=

(

const DtCompositePredicate &

orig

)

assignment operator

virtual DtVrfObjectPredicate* DtCompositePredicate::clone ( ) const

virtual

clone function

Implements DtVrfObjectPredicate.

Reimplemented in DtTaskableSubordinatePredicate, and DtAggregateSpatialModelPredicate.

virtual void DtCompositePredicate::addPredicate ( const DtVrfObjectPredicate &  predicate )

virtual

adds a sub-predicate

virtual void DtCompositePredicate::removePredicate ( const DtVrfObjectPredicate &  predicate )

virtual

removes a force type from the set of types to be checked

virtual bool DtCompositePredicate::hasPredicate ( const DtVrfObjectPredicate &  predicate ) const

virtual

returns true if the predicate is in the predicate list

virtual bool DtCompositePredicate::eval ( const DtVrfObject *  object )

protectedvirtual

The actual test this predicate performs.

Implements DtVrfObjectPredicate.

virtual bool DtCompositePredicate::predicateEqual ( const DtVrfObjectPredicate &  orig ) const

protectedvirtual

Used by equality operator used to compare predicates.

Reimplemented from DtVrfObjectPredicate.

virtual bool DtCompositePredicate::canEvalTrue ( const DtVrfObject *  vrfObject )

protectedvirtual

Returns

True only if all sub-predicates can return true.

Reimplemented from DtVrfObjectPredicate.

virtual bool DtCompositePredicate::canEvalFalse ( const DtVrfObject *  vrfObject )

protectedvirtual

Returns

True if any sub-predicate can return false.

Reimplemented from DtVrfObjectPredicate.

virtual void DtCompositePredicate::typeSpecificStringRep ( std::ostream &  str, int  indentLevel  ) const

protectedvirtual

Override in specific subclasses to print the predicate description to the stream.

Reimplemented from DtVrfObjectPredicate.

Member Data Documentation

DtList DtCompositePredicate::myPredicates

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/compositePredicate.h