The explicit goal selector makes extracts a specific goal from a specific goal set – both explicitly stated. More...

Inheritance diagram for Menge::BFSM::ExplicitGoalSelector:

Public Member Functions
	ExplicitGoalSelector ()
	Default constructor.

virtual Goal *	getGoal (const Agents::BaseAgent *agent) const
	Interface function for acquiring per-agent goals. More...

void	setGoalSet (std::map< size_t, GoalSet * > &goalSets)
	Gives the instance the opportunity to set the goal set. More...

void	setGoalSetID (size_t id)
	Sets the goal set identifier. More...

void	setGoalID (size_t id)
	Sets the goal identifier. More...

Public Member Functions inherited from Menge::BFSM::GoalSelector
	GoalSelector ()
	Default constructor.

Goal *	assignGoal (const Agents::BaseAgent *agent)
	Uses the goal selector to assign a goal to the given agent. More...

void	freeGoal (const Agents::BaseAgent agent, Goal goal)
	Informs the goal selector that the agent is done with the goal. More...

void	setPersistence (bool state)
	Sets the persistence of the goal. More...

bool	getPersistence () const
	Reports the persistence of the goal. More...

Public Member Functions inherited from Menge::Element
void	destroy ()
	This supplants the destructor. More...

virtual BFSM::Task *	getTask ()
	Return an optional task associated with this element. More...

virtual SceneGraph::GLNode *	getSGNode ()
	Returns an optional visualization element associated with the element. More...

Protected Attributes
size_t	_goalSetID
	The id of the goal set to draw from.

union {
size_t _goalID
	The identifier for the goal.

Goal * _goal
	The pointer to the goal.

};
	The goal associated with this goal selector. During parsing, it contains the id of the goal. After FSM construction, it contains a pointer to the actual goal.

Protected Attributes inherited from Menge::BFSM::GoalSelector
bool	_persistent
	Determines if the GoalSelector maintains persistent goals. More...

HASH_MAP< size_t, Goal * >	_assignedGoals
	A mapping from agent id to assigned goals. This will only contain meaningful values in one of two cases: More...

ReadersWriterLock	_lock
	The lock to maintain readers-writer access to the _assignedGoals.

Additional Inherited Members
Protected Member Functions inherited from Menge::BFSM::GoalSelector
virtual	~GoalSelector ()
	Default virtual destructor.

virtual void	lockResources ()
	Allows the goal selector to lock any resources it requires. More...

virtual void	releaseResources ()
	Allows the goal selector to release previously locked resources. More...

Detailed Description

The explicit goal selector makes extracts a specific goal from a specific goal set – both explicitly stated.

Member Function Documentation

Goal * Menge::BFSM::ExplicitGoalSelector::getGoal ( const Agents::BaseAgent * agent ) const

virtual

Interface function for acquiring per-agent goals.

Parameters

agent The agent for whom a goal is extracted.

void Menge::BFSM::ExplicitGoalSelector::setGoalID ( size_t id )

inline

Sets the goal identifier.

Parameters

id	The goal's id that belongs to this selector.

void Menge::BFSM::ExplicitGoalSelector::setGoalSet ( std::map< size_t, GoalSet * > & goalSets )

virtual

Gives the instance the opportunity to set the goal set.

This does nothing for instances which don't require a goal set. Otherwise, it extracts its required goal set.

Parameters

goalSets A mapping from goal set identifier to goal set pointers.

void Menge::BFSM::ExplicitGoalSelector::setGoalSetID ( size_t id )

inline

Sets the goal set identifier.

Parameters

id	The goal set's id that belongs to this selector.

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