#include <ComposeValidity.h>

Inheritance diagram for ComposeValidity:

Collaboration diagram for ComposeValidity:

[legend]

Public Types
Local Types
enum	LogicalOperator { AND , OR }

Public Types inherited from ValidityCheckerMethod
typedef MPBaseObject::GroupCfgType	GroupCfgType

typedef GroupCfgType::Formation	Formation

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
Construction
	ComposeValidity ()

	ComposeValidity (XMLNode &_node)

virtual	~ComposeValidity ()=default

Public Member Functions inherited from ValidityCheckerMethod
	ValidityCheckerMethod ()=default

	ValidityCheckerMethod (XMLNode &_node)

virtual	~ValidityCheckerMethod ()=default

bool	GetValidity () const
	Get the current meaning of "valid" (true is default). More...

void	ToggleValidity ()
	Switches the meaning of "valid" to "invalid" and vice versa. More...

bool	IsValid (Cfg &_cfg, CDInfo &_cdInfo, const std::string &_caller)

bool	IsValid (Cfg &_cfg, const std::string &_caller)

bool	IsValid (GroupCfgType &_cfg, CDInfo &_cdInfo, const std::string &_caller)

bool	IsValid (GroupCfgType &_cfg, const std::string &_caller)

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...

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 Member Functions
ValidityChecker Overrides
virtual bool	IsValidImpl (Cfg &_cfg, CDInfo &_cdInfo, const std::string &_callName) override

Protected Member Functions inherited from ValidityCheckerMethod
virtual bool	IsValidImpl (GroupCfgType &_cfg, CDInfo &_cdInfo, const std::string &_caller)

Protected Member Functions inherited from MPBaseObject
void	SetName (const std::string &_s)

const std::string &	GetBaseFilename () const

Protected Attributes
Internal State
LogicalOperator	m_operator
	The logical operator joining VC's. More...

std::vector< std::string >	m_vcLabels
	The VC labels to combine. More...

Protected Attributes inherited from ValidityCheckerMethod
bool	m_validity {true}
	Use standard validity? False indicates negation. More...

Protected Attributes inherited from MPBaseObject
bool	m_debug
	Print debug info? More...

Detailed Description

Composed validity checker which applies two or more validity conditions.

Member Enumeration Documentation

◆ LogicalOperator

enum ComposeValidity::LogicalOperator

Enumerator
AND
OR

Constructor & Destructor Documentation

◆ ComposeValidity() [1/2]

ComposeValidity::ComposeValidity ( )

◆ ComposeValidity() [2/2]

ComposeValidity::ComposeValidity ( XMLNode & _node )

◆ ~ComposeValidity()

virtual ComposeValidity::~ComposeValidity ( )

virtualdefault

Member Function Documentation

◆ IsValidImpl()

bool ComposeValidity::IsValidImpl	(	Cfg &	_cfg,
		CDInfo &	_cdInfo,
		const std::string &	_caller
	)

overrideprotectedvirtual

Implementation of the classification of a configuration to either cfree or cobst.

Parameters

_cfg	The individual configuration.
_cdInfo	Output for extra computed information such as clearance.
_caller	Name of the calling function.

Returns: True if _cfg is in cfree.

Implements ValidityCheckerMethod.

Field Documentation

◆ m_operator

LogicalOperator ComposeValidity::m_operator

protected

The logical operator joining VC's.

◆ m_vcLabels

std::vector<std::string> ComposeValidity::m_vcLabels

protected

The VC labels to combine.

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

/opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/ValidityCheckers/ComposeValidity.h
/opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/ValidityCheckers/ComposeValidity.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes