Parasol Planning Library (PPL)
Public Member Functions | Protected Attributes
PrintMapEvaluation Class Reference

#include <PrintMapEvaluation.h>

Inheritance diagram for PrintMapEvaluation:
Inheritance graph
[legend]
Collaboration diagram for PrintMapEvaluation:
Collaboration graph
[legend]

Public Member Functions

 PrintMapEvaluation ()
 Constructs a PrintMapEvaluation object. More...
 
 PrintMapEvaluation (string _baseName)
 
 PrintMapEvaluation (XMLNode &_node)
 
virtual ~PrintMapEvaluation ()
 
virtual void Print (ostream &_os) const
 
virtual bool operator() ()
 Write the map to a file. More...
 
- Public Member Functions inherited from MapEvaluatorMethod
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...
 
void SetActiveRobots (const std::vector< size_t > &_activeRobots)
 Set the active robots. More...
 
std::vector< size_t > GetActiveRobots () const
 Get the active robots. More...
 
 MapEvaluatorMethod ()=default
 
 MapEvaluatorMethod (XMLNode &_node)
 
virtual ~MapEvaluatorMethod ()=default
 
- Public Member Functions inherited from MPBaseObject
 MPBaseObject (const std::string &_label="", const std::string &_name="", bool _debug=false)
 
 MPBaseObject (XMLNode &_node)
 
virtual ~MPBaseObject ()
 
virtual void Initialize ()
 
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...
 
MPLibraryGetMPLibrary () const noexcept
 Get the owning MPLibrary. More...
 
bool IsRunning () const noexcept
 Check the library's running flag. More...
 
MPProblemGetMPProblem () const noexcept
 Get the library's current MPProblem. More...
 
EnvironmentGetEnvironment () const noexcept
 Get the current environment. More...
 
MPTaskGetTask () const noexcept
 Get the current task. More...
 
GroupTaskGetGroupTask () const noexcept
 Get the current group task. More...
 
MPSolutionTypeGetMPSolution () const noexcept
 
RoadmapTypeGetRoadmap (Robot *const _r=nullptr) const noexcept
 Get the current free-space roadmap. More...
 
GroupRoadmapTypeGetGroupRoadmap (RobotGroup *const _g=nullptr) const noexcept
 Get the current free-space group roadmap. More...
 
RoadmapTypeGetBlockRoadmap (Robot *const _r=nullptr) const noexcept
 Get the current obstacle-space roadmap. More...
 
PathGetPath (Robot *const _r=nullptr) const noexcept
 
GroupPathGetGroupPath (RobotGroup *const _g=nullptr) const noexcept
 Get the current best group path. More...
 
StatClassGetStatClass () const noexcept
 Get the current StatClass. More...
 
LocalObstacleMapGetLocalObstacleMap () const noexcept
 Get the local obstacle map. More...
 

Protected Attributes

string m_baseName
 The basename of the file to write. More...
 
- Protected Attributes inherited from MapEvaluatorMethod
std::vector< size_t > m_activeRobots
 
- Protected Attributes inherited from MPBaseObject
bool m_debug
 Print debug info? More...
 

Additional Inherited Members

- Public Types inherited from MapEvaluatorMethod
typedef std::unordered_map< size_t, std::unordered_map< size_t, std::vector< Range< double > > > > EdgeIntervals
 
- Public Types inherited from MPBaseObject
typedef DefaultWeight< CfgWeightType
 
typedef GenericStateGraph< Cfg, WeightTypeRoadmapType
 
typedef GroupCfg< RoadmapTypeGroupCfgType
 
typedef GroupLocalPlan< RoadmapTypeGroupWeightType
 
typedef GroupRoadmap< GroupCfgType, GroupWeightTypeGroupRoadmapType
 
- Protected Member Functions inherited from MPBaseObject
void SetName (const std::string &_s)
 
const std::string & GetBaseFilename () const
 

Detailed Description

Prints the roadmap to a file

Constructor & Destructor Documentation

◆ PrintMapEvaluation() [1/3]

PrintMapEvaluation::PrintMapEvaluation ( )

Constructs a PrintMapEvaluation object.

◆ PrintMapEvaluation() [2/3]

PrintMapEvaluation::PrintMapEvaluation ( string  _baseName)

Constructs a PrintMapEvaluation object with a base filename

Parameters
_basenameThe base name of the output file.

◆ PrintMapEvaluation() [3/3]

PrintMapEvaluation::PrintMapEvaluation ( XMLNode _node)

Constructs a PrintMapEvaluation object from an XML node

Parameters
_nodeThe XML node to use.

◆ ~PrintMapEvaluation()

PrintMapEvaluation::~PrintMapEvaluation ( )
virtual

Member Function Documentation

◆ operator()()

bool PrintMapEvaluation::operator() ( )
virtual

Write the map to a file.

Implements MapEvaluatorMethod.

◆ Print()

void PrintMapEvaluation::Print ( ostream &  _os) const
virtual

Print internal state of this object.

Parameters
_osThe std::ostream to print to.

Reimplemented from MPBaseObject.

Field Documentation

◆ m_baseName

string PrintMapEvaluation::m_baseName
protected

The basename of the file to write.


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