Simulation.Goal Class Reference

A goal is a satisfaction level of a need that an agent wants to achieve. More...

Public Member Functions

 Goal (string needToSatisfy, Needs.NeedSatisfactions satisfactionState)
 Create a new goal to achieve a specific Needs.NeedSatisfactions state for a specific need. More...
 
bool GoalAchieved (float satisfactionValue)
 True, if the specific NeedSatisfaction Goal is achieved. False otherwise. More...
 

Properties

string NeedToSatisfy [get]
 Which need should be satisfied by this goal. More...
 
Needs.NeedSatisfactions SatisfactionState [get]
 What is the current Needs.NeedSatisfactions state of the need this goal is concerned with. More...
 
bool HasBeenAchieved [get, set]
 Whether the goal has been achieved. More...
 

Detailed Description

A goal is a satisfaction level of a need that an agent wants to achieve.

Constructor & Destructor Documentation

Simulation.Goal.Goal ( string  needToSatisfy,
Needs.NeedSatisfactions  satisfactionState 
)

Create a new goal to achieve a specific Needs.NeedSatisfactions state for a specific need.

Parameters
needToSatisfyThe name of the need
satisfactionStateThe state that is desired

Member Function Documentation

bool Simulation.Goal.GoalAchieved ( float  satisfactionValue)

True, if the specific NeedSatisfaction Goal is achieved. False otherwise.

Parameters
satisfactionValue
Returns

Property Documentation

bool Simulation.Goal.HasBeenAchieved
getset

Whether the goal has been achieved.

string Simulation.Goal.NeedToSatisfy
get

Which need should be satisfied by this goal.

Needs.NeedSatisfactions Simulation.Goal.SatisfactionState
get

What is the current Needs.NeedSatisfactions state of the need this goal is concerned with.


The documentation for this class was generated from the following file:
  • Goal.cs