DtCompositePredicate Class Reference

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.

Inheritance diagram for DtCompositePredicate:

Public Member Functions
	DtCompositePredicate (bool negate=false)
virtual	~DtCompositePredicate ()
	DtCompositePredicate (const DtCompositePredicate &orig)
DtCompositePredicate &	operator= (const DtCompositePredicate &orig)
virtual DtVrfObjectPredicate *	clone () const
virtual void	addPredicate (const DtVrfObjectPredicate &predicate)
virtual void	removePredicate (const DtVrfObjectPredicate &predicate)
virtual bool	hasPredicate (const DtVrfObjectPredicate &predicate) const
virtual int	numPredicates () const
Public Member Functions inherited from DtVrfObjectPredicate
	DtVrfObjectPredicate (bool negate=false)
virtual	~DtVrfObjectPredicate ()
	DtVrfObjectPredicate (const DtVrfObjectPredicate &orig)
DtVrfObjectPredicate &	operator= (const DtVrfObjectPredicate &orig)
bool	operator== (const DtVrfObjectPredicate &orig) const
bool	operator!= (const DtVrfObjectPredicate &orig) const
virtual bool	negated () const
virtual void	setNegate (bool negate)
bool	isTrue (const DtSimObject *vrfObject) const
virtual bool	canBeTrue (const DtSimObject *vrfObject)
virtual bool	canBeFalse (const DtSimObject *vrfObject)
virtual void	stringRep (std::ostream &str, int indentLevel=0) const

Protected Member Functions
virtual bool	eval (const DtSimObject *vrfObject) const
virtual bool	predicateEqual (const DtVrfObjectPredicate &orig) const
virtual bool	canEvalTrue (const DtSimObject *vrfObject) const override
virtual bool	canEvalFalse (const DtSimObject *vrfObject) const override
virtual void	typeSpecificStringRep (std::ostream &str, int indentLevel) const

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 ()

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 DtFormationableSubordinatePredicate, 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 int DtCompositePredicate::numPredicates ( ) const

virtual

virtual bool DtCompositePredicate::eval ( const DtSimObject *  vrfObject ) const

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 DtSimObject *  vrfObject ) const

overrideprotectedvirtual

Returns

True only if all sub-predicates can return true.

Reimplemented from DtVrfObjectPredicate.

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

overrideprotectedvirtual

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.vrf5-1-branch/include/vrfobjcore/compositePredicate.h