PrintMapEvaluation< MPTraits > Class Template Reference

Public Member Functions
	PrintMapEvaluation ()
	Constructs a PrintMapEvaluation object.
	PrintMapEvaluation (string _baseName)
	PrintMapEvaluation (XMLNode &_node)
virtual void	Print (ostream &_os) const
virtual bool	operator() ()
	Write the map to a file. More...
MapEvaluator Interface
virtual void	SetEdgeIntervals (EdgeIntervals _edgeIntervals)
	Set the edge intervals of a roadmap. More...
virtual void	SetMinEndtime (double _minEndtime)
	Set the minimum end time of a path. More...
Active Robots
Todo: This is an artifact of developing robot groups. It should be replaced by using a proper subgroup where each robot within is active.
void	SetActiveRobots (const std::vector< size_t > &_activeRobots)
	Set the active robots.
std::vector< size_t >	GetActiveRobots () const
	Get the active robots.
Initialization
virtual void	Initialize ()
Name and Label Accessors
const std::string &	GetName () const
	Get the class name for this object.
const std::string &	GetLabel () const
	Get the unique label for this object.
std::string	GetNameAndLabel () const
	Get the unique string identifier for this object "m_name::m_label".
void	SetLabel (const std::string &)
	Set the unique label for this object.
MPLibrary Accessors
void	SetMPLibrary (MPLibrary *) noexcept
	Set the owning MPLibrary.
MPLibrary *	GetMPLibrary () const noexcept
	Get the owning MPLibrary.
bool	IsRunning () const noexcept
	Check the library's running flag.
DistanceMetricPointer	GetDistanceMetric (const std::string &) const noexcept
	Get a distance metric by label from the owning MPLibrary.
ValidityCheckerPointer	GetValidityChecker (const std::string &) const noexcept
	Get a validity checker by label from the owning MPLibrary.
NeighborhoodFinderPointer	GetNeighborhoodFinder (const std::string &) const noexcept
	Get a neighborhood finder by label from the owning MPLibrary.
SamplerPointer	GetSampler (const std::string &) const noexcept
	Get a sampler by label from the owning MPLibrary.
LocalPlannerPointer	GetLocalPlanner (const std::string &) const noexcept
	Get a local planner by label from the owning MPLibrary.
ExtenderPointer	GetExtender (const std::string &) const noexcept
	Get an extender by label from the owning MPLibrary.
PathModifierPointer	GetPathModifier (const std::string &) const noexcept
	Get a path modifier by label from the owning MPLibrary.
ConnectorPointer	GetConnector (const std::string &) const noexcept
	Get a connector by label from the owning MPLibrary.
MetricPointer	GetMetric (const std::string &) const noexcept
	Get a metric by label from the owning MPLibrary.
MapEvaluatorPointer	GetMapEvaluator (const std::string &) const noexcept
	Get a map evaluator by label from the owning MPLibrary.
MPStrategyPointer	GetMPStrategy (const std::string &) const noexcept
	Get a strategy by label from the owning MPLibrary.
MPTraits::MPTools *	GetMPTools () const noexcept
	Get the MPTools container from the owning MPLibrary.
Problem Accessors
MPProblem *	GetMPProblem () const noexcept
	Get the library's current MPProblem.
Environment *	GetEnvironment () const noexcept
	Get the current environment.
MPTask *	GetTask () const noexcept
	Get the current task.
GroupTask *	GetGroupTask () const noexcept
	Get the current group task.
Solution Accessors
MPSolution *	GetMPSolution () const noexcept
RoadmapType *	GetRoadmap (Robot *const _r=nullptr) const noexcept
	Get the current free-space roadmap.
GroupRoadmapType *	GetGroupRoadmap (RobotGroup *const _g=nullptr) const noexcept
	Get the current free-space group roadmap.
RoadmapType *	GetBlockRoadmap (Robot *const _r=nullptr) const noexcept
	Get the current obstacle-space roadmap.
Path *	GetPath (Robot *const _r=nullptr) const noexcept
	Get the current best path.
GroupPath *	GetGroupPath (RobotGroup *const _g=nullptr) const noexcept
	Get the current best group path.
StatClass *	GetStatClass () const noexcept
	Get the current StatClass.
LocalObstacleMap *	GetLocalObstacleMap () const noexcept
	Get the local obstacle map.
GoalTracker *	GetGoalTracker () const noexcept
	Get the goal tracker.

Public Types
Construction
typedef std::unordered_map< size_t, std::unordered_map< size_t, std::vector< Range< double > > > >	EdgeIntervals
Local Types
typedef MPTraits::RoadmapType	RoadmapType
typedef MPTraits::GroupRoadmapType	GroupRoadmapType
typedef MPTraits::LocalObstacleMap	LocalObstacleMap
typedef MPTraits::Path	Path
typedef MPTraits::GroupPathType	GroupPath
typedef MPTraits::MPLibrary	MPLibrary
typedef MPTraits::MPSolution	MPSolution
typedef MPTraits::GoalTracker	GoalTracker
typedef MPLibrary::SamplerPointer	SamplerPointer
typedef MPLibrary::LocalPlannerPointer	LocalPlannerPointer
typedef MPLibrary::ExtenderPointer	ExtenderPointer
typedef MPLibrary::PathModifierPointer	PathModifierPointer
typedef MPLibrary::ConnectorPointer	ConnectorPointer
typedef MPLibrary::MetricPointer	MetricPointer
typedef MPLibrary::MapEvaluatorPointer	MapEvaluatorPointer
typedef MPLibrary::MPStrategyPointer	MPStrategyPointer
typedef MPLibrary::DistanceMetricPointer	DistanceMetricPointer
typedef MPLibrary::ValidityCheckerPointer	ValidityCheckerPointer
typedef MPLibrary::NeighborhoodFinderPointer	NeighborhoodFinderPointer

Protected Member Functions
void	SetName (const std::string &_s)
const std::string &	GetBaseFilename () const

Protected Attributes
string	m_baseName
	The basename of the file to write.
bool	m_debug
	Print debug info?
Internal State
std::vector< size_t >	m_activeRobots

Detailed Description

template<typename MPTraits>
class PrintMapEvaluation< MPTraits >

Prints the roadmap to a file

Constructor & Destructor Documentation

PrintMapEvaluation() [1/2]

template<typename MPTraits >

PrintMapEvaluation< MPTraits >::PrintMapEvaluation

(

string

_baseName

)

Constructs a PrintMapEvaluation object with a base filename

Parameters

_basename

The base name of the output file.

PrintMapEvaluation() [2/2]

template<typename MPTraits >

PrintMapEvaluation< MPTraits >::PrintMapEvaluation

(

XMLNode &

_node

)

Constructs a PrintMapEvaluation object from an XML node

Parameters

_node

The XML node to use.

Member Function Documentation

Print()

template<typename MPTraits >

void PrintMapEvaluation< MPTraits >::Print ( ostream &  _os ) const

virtual

Print internal state of this object.

Parameters

_os	The std::ostream to print to.

Reimplemented from MPBaseObject< MPTraits >.

operator()()

template<typename MPTraits >

bool PrintMapEvaluation< MPTraits >::operator()

virtual

Write the map to a file.

Implements MapEvaluatorMethod< MPTraits >.

SetEdgeIntervals()

template<typename MPTraits >

virtual void MapEvaluatorMethod< MPTraits >::SetEdgeIntervals ( EdgeIntervals  _edgeIntervals )

virtualinherited

Set the edge intervals of a roadmap.

Reimplemented in SIPPMethod< MPTraits >.

SetMinEndtime()

template<typename MPTraits >

virtual void MapEvaluatorMethod< MPTraits >::SetMinEndtime ( double  _minEndtime )

virtualinherited

Set the minimum end time of a path.

Reimplemented in SIPPMethod< MPTraits >.

Initialize()

template<typename MPTraits >

virtual void MPBaseObject< MPTraits >::Initialize ( )

virtualinherited

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.

Reimplemented in ConnectorMethod< MPTraits >, CBSQuery< MPTraits >, ComposeEvaluator< MPTraits >, LazyQuery< MPTraits >, QueryMethod< MPTraits >, SIPPMethod< MPTraits >, TimeEvaluator< MPTraits >, TimeMetric< MPTraits >, AdaptiveRRT< MPTraits >, BasicPRM< MPTraits >, BasicRRTStrategy< MPTraits >, TogglePRMStrategy< MPTraits >, ValidationStrategy< MPTraits >, LKHSearch< MPTraits >, ClearanceUtility< MPTraits >, ReachabilityUtil< MPTraits >, SafeIntervalTool< MPTraits >, and TopologicalMap< MPTraits >.

SetName()

template<typename MPTraits >

void MPBaseObject< MPTraits >::SetName ( const std::string &  _s )

protectedinherited

Parameters

_s	Class name

GetBaseFilename()

template<typename MPTraits >

const std::string & MPBaseObject< MPTraits >::GetBaseFilename ( ) const

protectedinherited

Returns

base file name from MPProblem

Member Data Documentation

m_activeRobots

template<typename MPTraits >

std::vector<size_t> MapEvaluatorMethod< MPTraits >::m_activeRobots

protectedinherited

The active robots, used only by group map evaluators. Depending on the evaluator, the usage could be different, but the current use case is to set the robot(s) that are being moved, then a clearance check is done only considering those specified bodies (see MinimumClearanceEvaluator).

Todo:

This is an artifact of developing robot groups. It should be replaced by using a proper subgroup where each robot within is active.

---

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

• PrintMapEvaluation.h