Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Menge::BFSM::AutoCondition Class Reference

The definition of the "auto" condition. More...

#include <CondAuto.h>

Inheritance diagram for Menge::BFSM::AutoCondition:
Menge::BFSM::Condition Menge::Element

Public Member Functions

virtual bool conditionMet (Agents::BaseAgent *agent, const Goal *goal)
 The AutoCondition is always met – it is a tautology. More...
 
virtual Conditioncopy ()
 Create a copy of this condition. More...
 
- Public Member Functions inherited from Menge::BFSM::Condition
 Condition ()
 Constructor.
 
 Condition (const Condition &cond)
 Copy Constructor. More...
 
virtual void onEnter (Agents::BaseAgent *agent)
 Called when an agent enters a state with this exiting transition. More...
 
virtual void onLeave (Agents::BaseAgent *agent)
 Called when an agent exits the state with this transition. More...
 
- Public Member Functions inherited from Menge::Element
void destroy ()
 This supplants the destructor. More...
 
virtual BFSM::TaskgetTask ()
 Return an optional task associated with this element. More...
 
virtual SceneGraph::GLNodegetSGNode ()
 Returns an optional visualization element associated with the element. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Menge::BFSM::Condition
virtual ~Condition ()
 Protected destructor.
 

Detailed Description

The definition of the "auto" condition.

The auto condition always evaluates to true. It can be used to automatically progress from one state to another – or as a default case when multiple transitions are possible and the transition with the auto condition should be taken when no other transition proved to be valid.

Member Function Documentation

virtual bool Menge::BFSM::AutoCondition::conditionMet ( Agents::BaseAgent agent,
const Goal goal 
)
inlinevirtual

The AutoCondition is always met – it is a tautology.

Parameters
agentThe agent to test the transition for.
goalThe agent's goal (although this may be ignored).
Returns
True if the condition has been met, false otherwise.

Implements Menge::BFSM::Condition.

virtual Condition* Menge::BFSM::AutoCondition::copy ( )
inlinevirtual

Create a copy of this condition.

It is the responsibility of the caller to delete the object.

Returns
: A "deep copy" of this condition - such that there is no shared objects between this and its copy.

Implements Menge::BFSM::Condition.


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