All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions
continual_planning_executive::PlannerInterface Class Reference

Interfacing class for calling a symbolic planner. More...

#include <plannerInterface.h>

List of all members.

Public Types

enum  PlannerResult {
  PR_SUCCESS, PR_SUCCESS_TIMEOUT, PR_FAILURE_TIMEOUT, PR_FAILURE_UNREACHABLE,
  PR_FAILURE_OTHER
}

Public Member Functions

virtual void initialize (const std::string &domainFile, const std::vector< std::string > &options)=0
 Initialize the planner.
virtual PlannerResult monitor (const SymbolicState &init, const SymbolicState &goal, const Plan &plan)=0
 Monitor the current plan by checking if app(init, plan) reaches goal.
virtual PlannerResult plan (const SymbolicState &init, const SymbolicState &goal, Plan &plan)=0
 Execute the planner to produce a plan from init to goal.
 PlannerInterface ()
 Construct an interface for the planner.
virtual void setTimeout (double secs)=0
virtual ~PlannerInterface ()

Static Public Member Functions

static std::string PlannerResultStr (enum PlannerResult pr)

Detailed Description

Interfacing class for calling a symbolic planner.

Definition at line 13 of file plannerInterface.h.


Member Enumeration Documentation

Enumerator:
PR_SUCCESS 

A (optimal) plan was returned.

PR_SUCCESS_TIMEOUT 

A plan was returned, but the planner could have searched more.

PR_FAILURE_TIMEOUT 

No plan computed due to timeout.

PR_FAILURE_UNREACHABLE 

No plan found.

PR_FAILURE_OTHER 

Undetermined failure.

Definition at line 16 of file plannerInterface.h.


Constructor & Destructor Documentation

Construct an interface for the planner.

Definition at line 25 of file plannerInterface.h.

Definition at line 26 of file plannerInterface.h.


Member Function Documentation

virtual void continual_planning_executive::PlannerInterface::initialize ( const std::string &  domainFile,
const std::vector< std::string > &  options 
) [pure virtual]

Initialize the planner.

Parameters:
[in]domainFilethe domain to use for planning
[in]optionsa list of planner specific options
virtual PlannerResult continual_planning_executive::PlannerInterface::monitor ( const SymbolicState init,
const SymbolicState goal,
const Plan plan 
) [pure virtual]

Monitor the current plan by checking if app(init, plan) reaches goal.

Parameters:
[in]initthe initial state
[in]goalthe (partial) goal state
[in]planthe plan to monitor
virtual PlannerResult continual_planning_executive::PlannerInterface::plan ( const SymbolicState init,
const SymbolicState goal,
Plan plan 
) [pure virtual]

Execute the planner to produce a plan from init to goal.

Parameters:
[in]initthe initial state
[in]goalthe (partial) goal state
[out]planthe created plan

Definition at line 56 of file plannerInterface.h.

virtual void continual_planning_executive::PlannerInterface::setTimeout ( double  secs) [pure virtual]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


continual_planning_executive
Author(s): Christian Dornhege
autogenerated on Tue Jan 22 2013 12:24:43