VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
DtFormationableSubordinatePredicate Class Reference

Contains the declaration of class DtFormationableSubordinatePredicate, a predicate that tests if an entity is capable of being part of a formation as a subordinate. More...

Inheritance diagram for DtFormationableSubordinatePredicate:
Inheritance graph
[legend]

Public Member Functions

 DtFormationableSubordinatePredicate (bool negate=false)
 
virtual ~DtFormationableSubordinatePredicate ()
 destructor More...
 
 DtFormationableSubordinatePredicate (const DtFormationableSubordinatePredicate &orig)
 copy constructor More...
 
virtual DtVrfObjectPredicateclone () const
 clone function More...
 
- Public Member Functions inherited from DtCompositePredicate
 DtCompositePredicate (bool negate=false)
 default constructor More...
 
virtual ~DtCompositePredicate ()
 destructor More...
 
 DtCompositePredicate (const DtCompositePredicate &orig)
 copy constructor More...
 
DtCompositePredicateoperator= (const DtCompositePredicate &orig)
 assignment operator 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...
 
DtVrfObjectPredicateoperator= (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
 

Additional Inherited Members

- Static Public Member Functions inherited from DtVrfObjectPredicate
static const DtVrfObjectPredicatenullPredicate ()
 Returns an instance of a DtNullVrfObjectPredicate. More...
 
- Protected Member Functions inherited from DtCompositePredicate
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 inherited from DtCompositePredicate
DtList myPredicates
 
- Protected Attributes inherited from DtVrfObjectPredicate
bool myNegated
 

Detailed Description

Contains the declaration of class DtFormationableSubordinatePredicate, a predicate that tests if an entity is capable of being part of a formation as a subordinate.

Instances of DtFormationableSubordinatePredicate are used to determine whether a subordinate is capable part of a formation (i.e. it can move and its not embarked). It is composed of a DtAbleToMovePredicate and a negated DtEmbarkedOnPredicate.

Constructor & Destructor Documentation

DtFormationableSubordinatePredicate::DtFormationableSubordinatePredicate ( bool  negate = false)
virtual DtFormationableSubordinatePredicate::~DtFormationableSubordinatePredicate ( )
virtual

destructor

DtFormationableSubordinatePredicate::DtFormationableSubordinatePredicate ( const DtFormationableSubordinatePredicate orig)

copy constructor

Member Function Documentation

virtual DtVrfObjectPredicate* DtFormationableSubordinatePredicate::clone ( ) const
virtual

clone function

Reimplemented from DtCompositePredicate.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)