ConditionalEvaluator Class Reference

#include <ConditionalEvaluator.h>

Inheritance diagram for ConditionalEvaluator:

Collaboration diagram for ConditionalEvaluator:

Public Types
enum	Operator {   LT , LEQ , GT , GEQ ,   MOD }
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< Cfg >	WeightType
typedef GenericStateGraph< Cfg, WeightType >	RoadmapType
typedef GroupCfg< RoadmapType >	GroupCfgType
typedef GroupLocalPlan< RoadmapType >	GroupWeightType
typedef GroupRoadmap< GroupCfgType, GroupWeightType >	GroupRoadmapType

Public Member Functions
	ConditionalEvaluator (Operator _operator=LT, string _metric="", double _value=1.0)
	ConditionalEvaluator (XMLNode &_node)
virtual	~ConditionalEvaluator ()=default
virtual void	Print (ostream &_os) const
virtual bool	operator() ()
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...
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 Attributes
Operator	m_operator
	The operator to use. More...
string	m_metric
	The metric to evaluate. More...
double	m_value
	The numeric condition. 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
Protected Member Functions inherited from MPBaseObject
void	SetName (const std::string &_s)
const std::string &	GetBaseFilename () const

Detailed Description

Evaluates whether a given metric meets a specific numeric condition.

Member Enumeration Documentation

Operator

enum ConditionalEvaluator::Operator

Enumerator
LT
LEQ
GT
GEQ
MOD

Constructor & Destructor Documentation

ConditionalEvaluator() [1/2]

ConditionalEvaluator::ConditionalEvaluator	(	Operator	_operator = LT,
		string	_metric = "",
		double	_value = 1.0
	)

ConditionalEvaluator() [2/2]

ConditionalEvaluator::ConditionalEvaluator

(

XMLNode &

_node

)

~ConditionalEvaluator()

virtual ConditionalEvaluator::~ConditionalEvaluator ( )

virtualdefault

Member Function Documentation

operator()()

bool ConditionalEvaluator::operator() ( )

virtual

Evaluate a roadmap.

Returns

True if this roadmap meets the evaluation criteria.

Implements MapEvaluatorMethod.

Print()

void ConditionalEvaluator::Print ( ostream &  _os ) const

virtual

Print internal state of this object.

Parameters

_os	The std::ostream to print to.

Reimplemented from MPBaseObject.

Field Documentation

m_metric

string ConditionalEvaluator::m_metric

protected

The metric to evaluate.

m_operator

Operator ConditionalEvaluator::m_operator

protected

The operator to use.

m_value

double ConditionalEvaluator::m_value

protected

The numeric condition.

---

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

• /opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/MapEvaluators/ConditionalEvaluator.h
• /opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/MapEvaluators/ConditionalEvaluator.cpp