controller

Class PlanningAgent

java.lang.Object

core.player.Player

core.player.AbstractPlayer

controller.PlanningAgent

public class PlanningAgent
extends AbstractPlayer

Planning agent class. It represents an agent which uses a planner to reach a set of goals. See Agenda to find out how goals are structured.

Author:

Vladislav Nikolov Vasilev

Field Summary

Fields

Modifier and Type	Field and Description
protected Agenda	agenda
protected static int	callsPlanner
protected java.util.Set<java.lang.String>	connectionSet
protected static boolean	debugMode
protected static long	executionTime
protected static java.lang.String	gameConfigFile
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	gameElementVars
protected GameInformation	gameInformation
protected java.util.Iterator<PDDLAction>	iterPlan
protected static boolean	localHost
protected boolean	mustPlan
protected static int	numDiscrepancies
protected static int	numGoals
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	PDDLGameStateObjects
protected java.util.List<java.lang.String>	PDDLGameStatePredicates
protected PDDLPlan	PDDLPlan
protected java.util.List<java.lang.String>	reachedSavedGoalPredicates
protected static boolean	saveInformation
protected int	turn

Constructor Summary

Constructors

Constructor and Description
PlanningAgent(StateObservation stateObservation, ElapsedCpuTimer elapsedCpuTimer) Class constructor.

Method Summary

Modifier and Type	Method and Description
Types.ACTIONS	act(StateObservation stateObservation, ElapsedCpuTimer elapsedCpuTimer) Method called in each turn that returns the next action that the agent will execute.
boolean	checkEarlyReachedGoals(java.util.List<PDDLAction.Effect> effects) Method that checks whether a goal is reached beforehand by checking the effects of an action.
boolean	checkPreconditions(java.util.List<java.lang.String> preconditions, boolean showInformation) Method that checks whether the preconditions of an action are satisfied or not.
void	createProblemFile() Method that creates a PDDL problem file.
static void	displayStats() Method used to display game stats after the execution has finished.
PDDLPlan	findPlan() Method that allows the agent to find a plan to the current given goal.
java.util.HashSet<java.lang.String>[][]	getGameElementsMatrix(StateObservation stateObservation) Method that translates a game state observation to a matrix of strings which represent the elements of the game in each position according to the VGDDL registry.
static void	setDebugMode(boolean debugMode)
static void	setGameConfigFile(java.lang.String path)
static void	setLocalHost(boolean localHost)
static void	setSaveInformation(boolean saveInformation)
void	translateGameStateToPDDL(StateObservation stateObservation) Method that translates a game state observation to PDDL predicates.

Methods inherited from class core.player.AbstractPlayer

act

Methods inherited from class core.player.Player

draw, getAllActions, getLastAction, getPlayerID, isHuman, logAction, result, resultMulti, setPlayerID, setup, teardown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

gameConfigFile

protected static java.lang.String gameConfigFile

debugMode

protected static boolean debugMode

saveInformation

protected static boolean saveInformation

localHost

protected static boolean localHost

agenda

protected Agenda agenda

PDDLGameStatePredicates

protected java.util.List<java.lang.String> PDDLGameStatePredicates

PDDLGameStateObjects

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> PDDLGameStateObjects

PDDLPlan

protected PDDLPlan PDDLPlan

iterPlan

protected java.util.Iterator<PDDLAction> iterPlan

gameInformation

protected GameInformation gameInformation

reachedSavedGoalPredicates

protected java.util.List<java.lang.String> reachedSavedGoalPredicates

mustPlan

protected boolean mustPlan

connectionSet

protected java.util.Set<java.lang.String> connectionSet

gameElementVars

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> gameElementVars

turn

protected int turn

executionTime

protected static long executionTime

callsPlanner

protected static int callsPlanner

numDiscrepancies

protected static int numDiscrepancies

numGoals

protected static int numGoals

Constructor Detail

PlanningAgent

public PlanningAgent(StateObservation stateObservation,
                     ElapsedCpuTimer elapsedCpuTimer)

Class constructor. Creates a new planning agent.

Parameters:

stateObservation - State observation of the game.

elapsedCpuTimer - Elapsed CPU time.

Method Detail

act

public Types.ACTIONS act(StateObservation stateObservation,
                         ElapsedCpuTimer elapsedCpuTimer)

Method called in each turn that returns the next action that the agent will execute. It is responsible for controlling the agent's behaviour.

Specified by:

act in class Player

Parameters:

stateObservation - State observation of the game.

elapsedCpuTimer - Elapsed CPU time

Returns:

Returns the action that will be executed by the agent in the current turn.

checkPreconditions

public boolean checkPreconditions(java.util.List<java.lang.String> preconditions,
                                  boolean showInformation)

Method that checks whether the preconditions of an action are satisfied or not. In this case, the preconditions are going to be satisfied if all the positive preconditions are contained in the list of PDDL predicates and all the negative ones aren't contained.

Parameters:

preconditions - List of preconditions to check.

showInformation - Boolean telling whether to show or not debug information.

Returns:

Returns true if all preconditions are satisfied and false otherwise.

checkEarlyReachedGoals

public boolean checkEarlyReachedGoals(java.util.List<PDDLAction.Effect> effects)

Method that checks whether a goal is reached beforehand by checking the effects of an action. In case some goal is reached beforehand, the agenda is updated accordingly. updates the agenda accordingly

Parameters:

effects - List that contains the effect predicates of an action that will be checked.

Returns:

Returns true if some goal has been reached beforehand and false otherwise.

findPlan

public PDDLPlan findPlan()
                  throws PlannerException

Method that allows the agent to find a plan to the current given goal. It calls the planner and translates its output, generating in the process a new PDDLPlan instance.

Returns:

Returns a new PDDLPlan instance.

Throws:

PlannerException - Thrown when the planner's response status is not OK.

translateGameStateToPDDL

public void translateGameStateToPDDL(StateObservation stateObservation)

Method that translates a game state observation to PDDL predicates.

Parameters:

stateObservation - State observation of the game.

getGameElementsMatrix

public java.util.HashSet<java.lang.String>[][] getGameElementsMatrix(StateObservation stateObservation)

Method that translates a game state observation to a matrix of strings which represent the elements of the game in each position according to the VGDDL registry. There can be more than one game element in each position.

Parameters:

stateObservation - State observation of the game.

Returns:

Returns a matrix containing the elements of the game in each position.

createProblemFile

public void createProblemFile()

Method that creates a PDDL problem file. It writes the PDDL predicates, variables and the current goal to the problem file.

setGameConfigFile

public static void setGameConfigFile(java.lang.String path)

setDebugMode

public static void setDebugMode(boolean debugMode)

setSaveInformation

public static void setSaveInformation(boolean saveInformation)

setLocalHost

public static void setLocalHost(boolean localHost)

displayStats

public static void displayStats()

Method used to display game stats after the execution has finished. It displays the execution time, the number of goals that were reached, the number of times the planner was called and the number of discrepancies that were found.