| 
PlannerProxy Class Reference 
[Proxies]
#include <playerclient.h>
Inherits ClientProxy.
 
List of all members. 
 Detailed Description
The PlannerProxy proxy provides an interface to a 2D motion planner. 
 
 Constructor & Destructor Documentation
 
  
    
      
        
          |  PlannerProxy::PlannerProxy  | 
          (  | 
          PlayerClient *  | 
           pc,  | 
         
        
           | 
           | 
          unsigned short  | 
           index,  | 
         
        
           | 
           | 
          unsigned char  | 
           access = 'c' | 
         
        
           | 
          )  | 
           | 
         
       
     | 
   
 
 
 Member Function Documentation
 
  
    
      
        
          |  int PlannerProxy::SetCmdPose  | 
          (  | 
          double  | 
           gx,  | 
         
        
           | 
           | 
          double  | 
           gy,  | 
         
        
           | 
           | 
          double  | 
           ga | 
         
        
           | 
          )  | 
           | 
         
       
     | 
   
 
  
    | 
       
     | 
    
 
Set the goal pose (gx, gy, ga)       | 
   
 
 
  
    
      
        
          |  int PlannerProxy::GetWaypoints  | 
          (  | 
                     | 
           )  | 
           | 
         
       
     | 
   
 
  
    | 
       
     | 
    
 
Get the list of waypoints. Writes the result into the proxy rather than returning it to the caller.       | 
   
 
 
  
    
      
        
          |  int PlannerProxy::Enable  | 
          (  | 
          int  | 
           state           | 
           )  | 
           | 
         
       
     | 
   
 
  
    | 
       
     | 
    
 
Enable/disable the robot's motion. Set state to 1 to enable, 0 to disable.       | 
   
 
 
  
    
      
        
          |  void PlannerProxy::FillData  | 
          (  | 
          player_msghdr_t  | 
           hdr,  | 
         
        
           | 
           | 
          const char *  | 
           buffer | 
         
        
           | 
          )  | 
           [virtual] | 
         
       
     | 
   
 
  
    | 
       
     | 
    
 
All proxies must provide this method. It is used internally to parse new data when it is received. 
 
Reimplemented from ClientProxy.      | 
   
 
 Member Data Documentation
 
  
    | 
       
     | 
    
 
Did the planner find a valid path?       | 
   
 
 
  
    | 
       
     | 
    
 
Have we arrived at the goal?       | 
   
 
 
  
    | 
       
     | 
    
 
Current pose (m, m, radians).       | 
   
 
 
  
    | 
       
     | 
    
 
Current pose (m, m, radians).       | 
   
 
 
  
    | 
       
     | 
    
 
Current pose (m, m, radians).       | 
   
 
 
  
    | 
       
     | 
    
 
Goal location (m, m, radians)       | 
   
 
 
  
    | 
       
     | 
    
 
Goal location (m, m, radians)       | 
   
 
 
  
    | 
       
     | 
    
 
Goal location (m, m, radians)       | 
   
 
 
  
    | 
       
     | 
    
 
Current waypoint location (m, m, radians)       | 
   
 
 
  
    | 
       
     | 
    
 
Current waypoint location (m, m, radians)       | 
   
 
 
  
    | 
       
     | 
    
 
Current waypoint location (m, m, radians)       | 
   
 
 
  
    | 
       
     | 
    
 
Current waypoint index (handy if you already have the list of waypoints). May be negative if there's no plan, or if the plan is done       | 
   
 
 
  
    | 
       
     | 
    
 
Number of waypoints in the plan       | 
   
 
 
  
    | 
       
     | 
    
 
List of waypoints in the current plan (m,m,radians).       | 
   
 
 The documentation for this class was generated from the following file:
 
Generated on Tue May 3 14:15:53 2005 for Player by   1.3.6
 |