engine-mk1
Public Member Functions | List of all members
rz::planner::Planner Class Reference

Implements goal oriented action planning. More...

#include <Planner.hpp>

Public Member Functions

 Planner () noexcept
 < Default Constructor. More...
 
 Planner (const ConditionSet &worldState)
 
ActionSet plan (ActionSet actions, Action goal)
 Determines the series of Actions that will take the world state from it's current state to the state required by the goal. More...
 
void savePlan (std::string filename)
 Saves the graph of Actions generated during the last call to Planner::plan. More...
 
ConditionSet & getWorldState () noexcept
 
ConditionSet & setWorldState (const ConditionSet &worldState)
 

Detailed Description

Implements goal oriented action planning.

For more information and examples, see page Planner

Constructor & Destructor Documentation

rz::planner::Planner::Planner ( )
inlinenoexcept

< Default Constructor.

rz::planner::Planner::Planner ( const ConditionSet &  worldState)
inline
Parameters
worldStateConstructs the Planner with the passed initial world state.

Member Function Documentation

ActionSet Planner::plan ( ActionSet  actions,
Action  goal 
)

Determines the series of Actions that will take the world state from it's current state to the state required by the goal.

Parameters
actionsThe Actions available for the Planner to use to formulate plans.
goalAn Action that can only run in the desired goal state.
Returns
ActionSet The series of actions that will take you from the current world state to the goal world state.
void Planner::savePlan ( std::string  filename)

Saves the graph of Actions generated during the last call to Planner::plan.

The graph is saved in the DOT language.

Parameters
filenameThe filename to save the file to.

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