Parasol Planning Library (PPL)
NumNodesMetric Class Reference

#include <NumNodesMetric.h>

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

Public Member Functions

Construction
 NumNodesMetric ()
 
 NumNodesMetric (XMLNode &_node)
 
virtual ~NumNodesMetric ()=default
 
Metric Interface
virtual double operator() () override
 
- Public Member Functions inherited from MetricMethod
 MetricMethod ()=default
 
 MetricMethod (XMLNode &_node)
 
virtual ~MetricMethod ()=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 Print (std::ostream &_os) const
 
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...
 

Additional Inherited Members

- 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
 
- Protected Attributes inherited from MPBaseObject
bool m_debug
 Print debug info? More...
 

Detailed Description

Evaluates the number of nodes in the current roadmap.

Constructor & Destructor Documentation

◆ NumNodesMetric() [1/2]

NumNodesMetric::NumNodesMetric ( )

◆ NumNodesMetric() [2/2]

NumNodesMetric::NumNodesMetric ( XMLNode _node)

◆ ~NumNodesMetric()

virtual NumNodesMetric::~NumNodesMetric ( )
virtualdefault

Member Function Documentation

◆ operator()()

double NumNodesMetric::operator() ( )
overridevirtual

Compute a metric on the current roadmap.

Returns
Metric value

Implements MetricMethod.


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