VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtCompositePredicate Class Reference

Contains the DtCompositePredicate class declaration. More...

Inheritance diagram for DtCompositePredicate:
Inheritance graph
[legend]

Public Member Functions

 DtCompositePredicate (bool negate=false)
 default constructor
virtual ~DtCompositePredicate ()
 destructor
 DtCompositePredicate (const DtCompositePredicate &orig)
 copy constructor
DtCompositePredicateoperator= (const DtCompositePredicate &orig)
 assignment operator
virtual DtVrfObjectPredicateclone () const
 clone function
virtual void addPredicate (const DtVrfObjectPredicate &predicate)
 adds a sub-predicate
virtual void removePredicate (const DtVrfObjectPredicate &predicate)
 removes a force type from the set of types to be checked
virtual bool hasPredicate (const DtVrfObjectPredicate &predicate) const
 returns true if the predicate is in the predicate list
- Public Member Functions inherited from DtVrfObjectPredicate
 DtVrfObjectPredicate (bool negate=false)
 constructor
virtual ~DtVrfObjectPredicate ()
 destructor
 DtVrfObjectPredicate (const DtVrfObjectPredicate &orig)
 copy constructor
DtVrfObjectPredicateoperator= (const DtVrfObjectPredicate &orig)
 assignment operator
bool operator== (const DtVrfObjectPredicate &orig) const
 Equality operators used to compare predicates.
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.

Protected Member Functions

virtual bool eval (const DtVrfObject *object)
 The actual test this predicate performs.
virtual bool predicateEqual (const DtVrfObjectPredicate &orig) const
 Used by equality operator used to compare predicates.

Protected Attributes

DtList myPredicates
- Protected Attributes inherited from DtVrfObjectPredicate
bool myNegated

Additional Inherited Members

- Static Public Member Functions inherited from DtVrfObjectPredicate
static const DtVrfObjectPredicatenullPredicate ()
 Returns an instance of a DtNullVrfObjectPredicate.

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.

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.

Member Data Documentation

DtList DtCompositePredicate::myPredicates
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)