Parasol Planning Library (PPL)
Data Structures
ValidationStrategy< MPTraits > Class Template Reference

#include <ValidationStrategy.h>

Inheritance diagram for ValidationStrategy< MPTraits >:
Inheritance graph
[legend]
Collaboration diagram for ValidationStrategy< MPTraits >:
Collaboration graph
[legend]

Data Structures

struct  GoldStandard
 A gold standard input to validate against the target strategy. More...
 

Public Types

Motion Planning Types
typedef MPTraits::CfgType CfgType
 
typedef MPTraits::WeightType WeightType
 
typedef MPTraits::RoadmapType RoadmapType
 
typedef RoadmapType::VID VID
 
- Public Types inherited from MPStrategyMethod< MPTraits >
typedef size_t VID
 

Public Member Functions

Construction
 ValidationStrategy ()
 
 ValidationStrategy (XMLNode &_node)
 
virtual ~ValidationStrategy ()=default
 
MPStrategyMethod Overrides
virtual void Initialize () override
 
virtual void Run () override
 Call Iterate until EvaluateMap is true. More...
 
virtual void Finalize () override
 Clean-up and output results. More...
 
- Public Member Functions inherited from MPStrategyMethod< MPTraits >
 MPStrategyMethod ()=default
 
 MPStrategyMethod (XMLNode &_node)
 
virtual ~MPStrategyMethod ()
 
virtual void Print (std::ostream &_os) const override
 
void operator() ()
 Execute the strategy by calling Initialize, Run, and Finalize. More...
 
void EnableOutputFiles (const bool _enable=true)
 
virtual void Initialize ()
 

Additional Inherited Members

- Protected Member Functions inherited from MPStrategyMethod< MPTraits >
virtual bool EvaluateMap ()
 Check if we satisfied all map evaluators. More...
 
virtual void Iterate ()
 Execute one iteration of the strategy. 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 Attributes inherited from MPStrategyMethod< MPTraits >
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
 The number of executed iterations. More...
 
bool m_writeOutput
 Write output at the end? More...
 
bool m_clearMap
 Clear the roadmap(s) before run? More...
 

Detailed Description

template<typename MPTraits>
class ValidationStrategy< MPTraits >

Runs another MPStrategy (the target) and compares the output(s) to gold standard(s) specified as input files. This exists to test changes in the code and ensure that the target's behavior hasn't changed.

Member Typedef Documentation

◆ CfgType

template<typename MPTraits >
typedef MPTraits::CfgType ValidationStrategy< MPTraits >::CfgType

◆ RoadmapType

template<typename MPTraits >
typedef MPTraits::RoadmapType ValidationStrategy< MPTraits >::RoadmapType

◆ VID

template<typename MPTraits >
typedef RoadmapType::VID ValidationStrategy< MPTraits >::VID

◆ WeightType

template<typename MPTraits >
typedef MPTraits::WeightType ValidationStrategy< MPTraits >::WeightType

Constructor & Destructor Documentation

◆ ValidationStrategy() [1/2]

template<typename MPTraits >
ValidationStrategy< MPTraits >::ValidationStrategy

◆ ValidationStrategy() [2/2]

template<typename MPTraits >
ValidationStrategy< MPTraits >::ValidationStrategy ( XMLNode _node)

◆ ~ValidationStrategy()

template<typename MPTraits >
virtual ValidationStrategy< MPTraits >::~ValidationStrategy ( )
virtualdefault

Member Function Documentation

◆ Finalize()

template<typename MPTraits >
void ValidationStrategy< MPTraits >::Finalize
overridevirtual

Clean-up and output results.

Reimplemented from MPStrategyMethod< MPTraits >.

◆ Initialize()

template<typename MPTraits >
void ValidationStrategy< MPTraits >::Initialize
overridevirtual

◆ Run()

template<typename MPTraits >
void ValidationStrategy< MPTraits >::Run
overridevirtual

Call Iterate until EvaluateMap is true.

Reimplemented from MPStrategyMethod< MPTraits >.


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