#include <BasicPRM.h>

Inheritance diagram for BasicPRM:

[legend]

Collaboration diagram for BasicPRM:

[legend]

Data Structures
struct	SamplerSetting
	Settings for a specific sampler. More...

Public Types
Motion Planning Types
typedef MPBaseObject::RoadmapType	RoadmapType

typedef RoadmapType::VID	VID

Public Types inherited from MPStrategyMethod
typedef size_t	VID

Public Types inherited from MPBaseObject
typedef DefaultWeight< Cfg >	WeightType

typedef GenericStateGraph< Cfg, WeightType >	RoadmapType

typedef GroupCfg< RoadmapType >	GroupCfgType

typedef GroupLocalPlan< RoadmapType >	GroupWeightType

typedef GroupRoadmap< GroupCfgType, GroupWeightType >	GroupRoadmapType

Public Member Functions
Construction
	BasicPRM ()

	BasicPRM (XMLNode &_node)

virtual	~BasicPRM ()=default

MPBaseObject Overrides
virtual void	Print (std::ostream &_os) const override

Public Member Functions inherited from MPStrategyMethod
	MPStrategyMethod ()=default

	MPStrategyMethod (XMLNode &_node)

virtual	~MPStrategyMethod ()

void	operator() ()
	Execute the strategy by calling Initialize, Run, and Finalize. More...

void	EnableOutputFiles (const bool _enable=true)

virtual void	Initialize ()

Public Member Functions inherited from MPBaseObject
	MPBaseObject (const std::string &_label="", const std::string &_name="", bool _debug=false)

	MPBaseObject (XMLNode &_node)

virtual	~MPBaseObject ()

const std::string &	GetName () const
	Get the class name for this object. More...

const std::string &	GetLabel () const
	Get the unique label for this object. More...

std::string	GetNameAndLabel () const
	Get the unique string identifier for this object "m_name::m_label". More...

void	SetLabel (const std::string &)
	Set the unique label for this object. More...

void	SetMPLibrary (MPLibrary *) noexcept
	Set the owning MPLibrary. More...

MPLibrary *	GetMPLibrary () const noexcept
	Get the owning MPLibrary. More...

bool	IsRunning () const noexcept
	Check the library's running flag. More...

MPProblem *	GetMPProblem () const noexcept
	Get the library's current MPProblem. More...

Environment *	GetEnvironment () const noexcept
	Get the current environment. More...

MPTask *	GetTask () const noexcept
	Get the current task. More...

GroupTask *	GetGroupTask () const noexcept
	Get the current group task. More...

MPSolutionType *	GetMPSolution () const noexcept

RoadmapType *	GetRoadmap (Robot *const _r=nullptr) const noexcept
	Get the current free-space roadmap. More...

GroupRoadmapType *	GetGroupRoadmap (RobotGroup *const _g=nullptr) const noexcept
	Get the current free-space group roadmap. More...

RoadmapType *	GetBlockRoadmap (Robot *const _r=nullptr) const noexcept
	Get the current obstacle-space roadmap. More...

Path *	GetPath (Robot *const _r=nullptr) const noexcept

GroupPath *	GetGroupPath (RobotGroup *const _g=nullptr) const noexcept
	Get the current best group path. More...

StatClass *	GetStatClass () const noexcept
	Get the current StatClass. More...

LocalObstacleMap *	GetLocalObstacleMap () const noexcept
	Get the local obstacle map. More...

Protected Member Functions
MPStrategyMethod Overrides
virtual void	Initialize () override

virtual void	Iterate () override
	Execute one iteration of the strategy. More...

Helpers
std::vector< VID >	Sample ()

void	Connect (const std::vector< VID > &_vids)

Protected Member Functions inherited from MPStrategyMethod
virtual void	Run ()
	Call Iterate until EvaluateMap is true. More...

virtual bool	EvaluateMap ()
	Check if we satisfied all map evaluators. More...

virtual void	Finalize ()
	Clean-up and output results. More...

virtual void	ClearRoadmap ()
	Pre-clear the roadmap(s) if requested. More...

virtual size_t	GenerateStart (const std::string &_samplerLabel="")

virtual std::vector< size_t >	GenerateGoals (const std::string &_samplerLabel="")

Protected Member Functions inherited from MPBaseObject
void	SetName (const std::string &_s)

const std::string &	GetBaseFilename () const

Protected Attributes
Internal State
std::vector< SamplerSetting >	m_samplers
	Sampler labels with number and attempts of sampler. More...

std::vector< std::string >	m_connectorLabels
	Connector labels for node-to-node. More...

std::string	m_inputMapFilename
	Input roadmap to initialize map. More...

Fix-base hacks
To be removed when we properly implement path constraints or perhaps a sampler-method option.
bool	m_fixBase {false}

std::unique_ptr< Boundary >	m_samplingBoundary
	An optional sampling boundary for fixing the base. More...

Protected Attributes inherited from MPStrategyMethod
std::string	m_querySampler
	Sampler for generating start/goal. More...

std::vector< std::string >	m_meLabels
	The list of map evaluators to use. More...

size_t	m_iterations {0}
	The number of executed iterations. More...

bool	m_writeOutput {true}
	Write output at the end? More...

bool	m_clearMap {false}
	Clear the roadmap(s) before run? More...

Protected Attributes inherited from MPBaseObject
bool	m_debug
	Print debug info? More...

Detailed Description

Basic PRM algorithm.

Reference: Lydia E. Kavraki and Petr Svestka and Jean-Claude Latombe and Mark H. Overmars. "Probabilistic Roadmaps for Path Planning in High-Dimensional Configuration Spaces". TRO 1996.

Member Typedef Documentation

◆ RoadmapType

typedef MPBaseObject::RoadmapType BasicPRM::RoadmapType

◆ VID

typedef RoadmapType::VID BasicPRM::VID

Constructor & Destructor Documentation

◆ BasicPRM() [1/2]

BasicPRM::BasicPRM ( )

◆ BasicPRM() [2/2]

BasicPRM::BasicPRM ( XMLNode & _node )

◆ ~BasicPRM()

virtual BasicPRM::~BasicPRM ( )

virtualdefault

Member Function Documentation

◆ Connect()

void BasicPRM::Connect ( const std::vector< VID > & _vids )

protected

Connect nodes in the roadmap.

Parameters

_vids A set of node VIDs to connect to the rest of the roadmap.

◆ Initialize()

void BasicPRM::Initialize ( )

overrideprotectedvirtual

Initialize this object for the current MPProblem. This should reset any internal state of the algorithms so that they are ready for execution. It is also the place to initialize any state that depends on the current problem.

Warning: This member will be called for every compiled algorithm in the planning library - even those that will not be used. If an algorithm needs to do expenisve setup, then this method should only set a flag that tells it to do so on first use. The only exceptions are the MPStrategies, which will only have their initialize called on first use.

Todo:: Move input map parsing to the MPSolution somehow?

Reimplemented from MPBaseObject.

Reimplemented in TogglePRMStrategy.

◆ Iterate()

void BasicPRM::Iterate ( )

overrideprotectedvirtual

Execute one iteration of the strategy.

Reimplemented from MPStrategyMethod.

Reimplemented in TogglePRMStrategy.

◆ Print()

void BasicPRM::Print ( std::ostream & _os ) const

overridevirtual

Print internal state of this object.

Parameters

_os	The std::ostream to print to.

Reimplemented from MPStrategyMethod.

Reimplemented in TogglePRMStrategy.

◆ Sample()

std::vector< size_t > BasicPRM::Sample ( )

protected

Sample and add configurations to the roadmap.

Returns: The generated VIDs for the successful samples.

Field Documentation

◆ m_connectorLabels

std::vector<std::string> BasicPRM::m_connectorLabels

protected

Connector labels for node-to-node.

◆ m_fixBase

bool BasicPRM::m_fixBase {false}

protected

Keep the base fixed to the start cfg?

◆ m_inputMapFilename

std::string BasicPRM::m_inputMapFilename

protected

Input roadmap to initialize map.

◆ m_samplers

std::vector<SamplerSetting> BasicPRM::m_samplers

protected

Sampler labels with number and attempts of sampler.

◆ m_samplingBoundary

std::unique_ptr<Boundary> BasicPRM::m_samplingBoundary

protected

An optional sampling boundary for fixing the base.

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

/opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/MPStrategies/BasicPRM.h
/opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/MPStrategies/BasicPRM.cpp

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ RoadmapType

◆ VID

Constructor & Destructor Documentation

◆ BasicPRM() [1/2]

◆ BasicPRM() [2/2]

◆ ~BasicPRM()

Member Function Documentation

◆ Connect()

◆ Initialize()

◆ Iterate()

◆ Print()

◆ Sample()

Field Documentation

◆ m_connectorLabels

◆ m_fixBase

◆ m_inputMapFilename

◆ m_samplers

◆ m_samplingBoundary