Public Member Functions | List of all members
DirectPlanner Class Reference

DirectPlanner class implements simple planner, which creates direct path from start to goal position. More...

#include <DirectPlanner.h>

Inheritance diagram for DirectPlanner:
Inheritance graph
[legend]

Public Member Functions

DirectPlannerClone () const override
 Method for cloning objects. Creates copy of object in memmory and return pointer to copy. More...
 
bool CreateGlobalPath () override
 Nothing. More...
 
 DirectPlanner (const Map &map, const EnvironmentOptions &options, const Point &start, const Point &goal, const float &radius)
 DirectPlanner constructor with parametes. More...
 
 DirectPlanner (const DirectPlanner &obj)
 DirectPlanner copy constructor. More...
 
bool GetNext (const Point &curr, Point &next) override
 Returns current goal of agent. Always return goal position. More...
 
DirectPlanneroperator= (const DirectPlanner &obj)
 Assignment operator. More...
 
 ~DirectPlanner () override
 DirectPlanner destructor. More...
 
- Public Member Functions inherited from PathPlanner
PathPlanneroperator= (const PathPlanner &obj)
 Assignment operator. More...
 
 PathPlanner (const PathPlanner &obj)
 PathPlanner copy constructor. More...
 
 PathPlanner (const Map &map, const EnvironmentOptions &options, const Point &start, const Point &goal, const float &radius)
 PathPlanner constructor with parametes. More...
 
virtual ~PathPlanner ()
 Virtual PathPlanner destructor. More...
 

Detailed Description

DirectPlanner class implements simple planner, which creates direct path from start to goal position.

Definition at line 17 of file DirectPlanner.h.

Constructor & Destructor Documentation

DirectPlanner::DirectPlanner ( const Map map,
const EnvironmentOptions options,
const Point start,
const Point goal,
const float &  radius 
)

DirectPlanner constructor with parametes.

Parameters
mapStatic environment map. It contains information about grid and static obstacles boundaries. More about it see in Main page and Map class.
optionsEnvironment and algorithm options. See EnvironmentOptions class.
startStart position of agent.
goalGoal position of agent.
radiusRadius of agent.

Definition at line 21 of file DirectPlanner.cpp.

DirectPlanner::DirectPlanner ( const DirectPlanner obj)

DirectPlanner copy constructor.

Parameters
objObject to copy.

Definition at line 24 of file DirectPlanner.cpp.

DirectPlanner::~DirectPlanner ( )
override

DirectPlanner destructor.

Definition at line 26 of file DirectPlanner.cpp.

Member Function Documentation

DirectPlanner * DirectPlanner::Clone ( ) const
overridevirtual

Method for cloning objects. Creates copy of object in memmory and return pointer to copy.

Returns
Pointer to copy of object

Implements PathPlanner.

Definition at line 28 of file DirectPlanner.cpp.

bool DirectPlanner::CreateGlobalPath ( )
overridevirtual

Nothing.

Returns
Always true.

Implements PathPlanner.

Definition at line 16 of file DirectPlanner.cpp.

bool DirectPlanner::GetNext ( const Point curr,
Point next 
)
overridevirtual

Returns current goal of agent. Always return goal position.

Parameters
[in]currCurrent position of agent.
[out]nextCurrent goal of agent.

Implements PathPlanner.

Definition at line 10 of file DirectPlanner.cpp.

DirectPlanner & DirectPlanner::operator= ( const DirectPlanner obj)

Assignment operator.

Parameters
objObject to assign.
Returns
Reference to assigned object.

Definition at line 33 of file DirectPlanner.cpp.


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


ORCAStar
Author(s): Stepan Drgachev
autogenerated on Wed Jul 15 2020 16:13:14