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

A condition based on the boolean negation of a single condition. More...

#include <CondBoolean.h>

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

Public Member Functions

 NotCondition ()
 Constructor.
 
 NotCondition (const NotCondition &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...
 
virtual bool conditionMet (Agents::BaseAgent *agent, const Goal *goal)
 The GoalCondition's condition is met when the agent is within a distance to the goal. 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...
 
- 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...
 

Protected Member Functions

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

Protected Attributes

Condition_op
 The boolean operand to negate.
 

Friends

class NotCondFactory
 

Detailed Description

A condition based on the boolean negation of a single condition.

Constructor & Destructor Documentation

Menge::BFSM::NotCondition::NotCondition ( const NotCondition cond)

Copy Constructor.

Parameters
condThe condition to copy from.

Member Function Documentation

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

The GoalCondition's condition is met when the agent is within a distance to the goal.

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.

Condition * Menge::BFSM::NotCondition::copy ( )
virtual

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.

void Menge::BFSM::NotCondition::onEnter ( Agents::BaseAgent agent)
virtual

Called when an agent enters a state with this exiting transition.

Sub-classes should use this function as the opportunity to cache any particular per-agent data.

Parameters
agentThe agent who has entered the state which uses this transition.

Reimplemented from Menge::BFSM::Condition.

void Menge::BFSM::NotCondition::onLeave ( Agents::BaseAgent agent)
virtual

Called when an agent exits the state with this transition.

Parameters
agentThe agent who left the state.

Reimplemented from Menge::BFSM::Condition.


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