Detailed Description

A holonomic reactive navigation method, based on Virtual Force Fields (VFF).

These are the optional parameters of the method which can be set by means of a configuration file passed to the constructor or to CHolonomicND::initialize (see also the field CHolonomicVFF::options).

# Section name can be changed via setConfigFileSectionName()
[VFF_CONFIG]
TARGET_SLOW_APPROACHING_DISTANCE = 0.10  // For stopping gradually
TARGET_ATTRACTIVE_FORCE          = 20    // Dimension-less (may have to be
tuned depending on the density of obstacle sampling)

See also: CAbstractHolonomicReactiveMethod,CReactiveNavigationSystem

Definition at line 50 of file CHolonomicVFF.h.

#include <mrpt/nav/holonomic/CHolonomicVFF.h>

Inheritance diagram for mrpt::nav::CHolonomicVFF:

Classes
struct	TOptions
	Algorithm options. More...

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

	CHolonomicVFF (const mrpt::utils::CConfigFileBase *INI_FILE=nullptr)
	Initialize the parameters of the navigator, from some configuration file, or default values if set to NULL. More...

void	navigate (const NavInput &ni, NavOutput &no) override
	Invokes the holonomic navigation algorithm itself. More...

void	initialize (const mrpt::utils::CConfigFileBase &INI_FILE) override
	Initialize the parameters of the navigator, reading from the default section name (see derived classes) or the one set via setConfigFileSectionName() More...

virtual void	saveConfigFile (mrpt::utils::CConfigFileBase &c) const override
	saves all available parameters, in a forma loadable by `initialize()` More...

double	getTargetApproachSlowDownDistance () const override
	Returns the actual value of this parameter [m], as set via the children class options structure. More...

void	setTargetApproachSlowDownDistance (const double dist) override
	Sets the actual value of this parameter [m]. More...

void	setConfigFileSectionName (const std::string &sectName)
	Defines the name of the section used in initialize() More...

std::string	getConfigFileSectionName () const
	Gets the name of the section used in initialize() More...

void	setAssociatedPTG (mrpt::nav::CParameterizedTrajectoryGenerator *ptg)
	Optionally, sets the associated PTG, just in case a derived class requires this info (not required for methods where the robot kinematics are totally abstracted) More...

mrpt::nav::CParameterizedTrajectoryGenerator *	getAssociatedPTG () const
	Returns the pointer set by setAssociatedPTG() More...

void	enableApproachTargetSlowDown (bool enable)

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

RTTI classes and functions
mrpt::utils::CObject::Ptr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

static CAbstractHolonomicReactiveMethod::Ptr	Factory (const std::string &className) noexcept

static CAbstractHolonomicReactiveMethod *	Create (const std::string &className) noexcept
	Class factory from class name, e.g. More...

Public Attributes
TOptions	options
	Parameters of the algorithm (can be set manually or loaded from CHolonomicVFF::initialize or options.loadFromConfigFile(), etc.) More...

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version) override
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

Protected Attributes
mrpt::nav::CParameterizedTrajectoryGenerator *	m_associatedPTG
	If applicable, this will contain the argument of the most recent call to setAssociatedPTG() More...

bool	m_enableApproachTargetSlowDown
	Whether to decrease speed when approaching target. More...

RTTI stuff
using	Ptr = std::shared_ptr< CHolonomicVFF >

using	ConstPtr = std::shared_ptr< const CHolonomicVFF >

static mrpt::utils::CLASSINIT	_init_CHolonomicVFF

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CHolonomicVFF"

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

static const mrpt::utils::TRuntimeClassId &	GetRuntimeClassIdStatic ()

static mrpt::utils::CObject *	CreateObject ()

template<typename... Args>
static Ptr	Create (Args &&... args)

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ ConstPtr

using mrpt::nav::CHolonomicVFF::ConstPtr = std::shared_ptr<const CHolonomicVFF >

Definition at line 52 of file CHolonomicVFF.h.

◆ Ptr

using mrpt::nav::CHolonomicVFF::Ptr = std::shared_ptr< CHolonomicVFF >

A typedef for the associated smart pointer

Definition at line 52 of file CHolonomicVFF.h.

Constructor & Destructor Documentation

◆ CHolonomicVFF()

mrpt::nav::CHolonomicVFF::CHolonomicVFF ( const mrpt::utils::CConfigFileBase * INI_FILE = nullptr )

Initialize the parameters of the navigator, from some configuration file, or default values if set to NULL.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::nav::CHolonomicVFF::_GetBaseClass ( )

staticprotected

◆ clone()

virtual mrpt::utils::CObject* mrpt::nav::CHolonomicVFF::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ Create() [1/2]

template<typename... Args>

static Ptr mrpt::nav::CHolonomicVFF::Create ( Args &&... args )

inlinestatic

Definition at line 52 of file CHolonomicVFF.h.

◆ Create() [2/2]

static CAbstractHolonomicReactiveMethod* mrpt::nav::CAbstractHolonomicReactiveMethod::Create ( const std::string & className )

staticnoexceptinherited

Class factory from class name, e.g.

"CHolonomicVFF", etc.

Exceptions

std::logic_error On invalid or missing parameters.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::nav::CHolonomicVFF::CreateObject ( )

static

◆ enableApproachTargetSlowDown()

void mrpt::nav::CAbstractHolonomicReactiveMethod::enableApproachTargetSlowDown ( bool enable )

inlineinherited

Definition at line 121 of file CAbstractHolonomicReactiveMethod.h.

References mrpt::nav::CAbstractHolonomicReactiveMethod::m_enableApproachTargetSlowDown.

Referenced by mrpt::nav::CAbstractPTGBasedReactive::build_movement_candidate().

Here is the caller graph for this function:

◆ Factory()

CAbstractHolonomicReactiveMethod::Ptr CAbstractHolonomicReactiveMethod::Factory ( const std::string & className )

staticnoexceptinherited

Definition at line 52 of file CAbstractHolonomicReactiveMethod.cpp.

References mrpt::utils::TRuntimeClassId::createObject(), mrpt::utils::findRegisteredClass(), and mrpt::utils::registerAllPendingClasses().

Referenced by mrpt::nav::CAbstractPTGBasedReactive::setHolonomicMethod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssociatedPTG()

mrpt::nav::CParameterizedTrajectoryGenerator * CAbstractHolonomicReactiveMethod::getAssociatedPTG ( ) const

inherited

Returns the pointer set by setAssociatedPTG()

Definition at line 47 of file CAbstractHolonomicReactiveMethod.cpp.

References mrpt::nav::CAbstractHolonomicReactiveMethod::m_associatedPTG.

Referenced by mrpt::nav::CHolonomicFullEval::evalSingleTarget(), and mrpt::nav::CHolonomicFullEval::navigate().

Here is the caller graph for this function:

◆ getConfigFileSectionName()

std::string CAbstractHolonomicReactiveMethod::getConfigFileSectionName ( ) const

inherited

Gets the name of the section used in initialize()

Definition at line 36 of file CAbstractHolonomicReactiveMethod.cpp.

References mrpt::nav::CAbstractHolonomicReactiveMethod::m_cfgSectionName.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::nav::CHolonomicVFF::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::nav::CAbstractHolonomicReactiveMethod.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::nav::CHolonomicVFF::GetRuntimeClassIdStatic ( )

static

◆ getTargetApproachSlowDownDistance()

double mrpt::nav::CHolonomicVFF::getTargetApproachSlowDownDistance ( ) const

inlineoverridevirtual

Returns the actual value of this parameter [m], as set via the children class options structure.

See also: setTargetApproachSlowDownDistance()

Implements mrpt::nav::CAbstractHolonomicReactiveMethod.

Definition at line 88 of file CHolonomicVFF.h.

References options, and mrpt::nav::CHolonomicVFF::TOptions::TARGET_SLOW_APPROACHING_DISTANCE.

◆ initialize()

void CHolonomicVFF::initialize ( const mrpt::utils::CConfigFileBase & c )

overridevirtual

Initialize the parameters of the navigator, reading from the default section name (see derived classes) or the one set via setConfigFileSectionName()

Implements mrpt::nav::CAbstractHolonomicReactiveMethod.

Definition at line 34 of file CHolonomicVFF.cpp.

◆ navigate()

void CHolonomicVFF::navigate	(	const NavInput &	ni,
		NavOutput &	no
	)

overridevirtual

Invokes the holonomic navigation algorithm itself.

See the description of the input/output structures for details on each parameter.

Implements mrpt::nav::CAbstractHolonomicReactiveMethod.

Definition at line 46 of file CHolonomicVFF.cpp.

References ASSERT_, mrpt::nav::CAbstractHolonomicReactiveMethod::NavOutput::desiredDirection, mrpt::nav::CAbstractHolonomicReactiveMethod::NavOutput::desiredSpeed, mrpt::nav::CAbstractHolonomicReactiveMethod::NavOutput::logRecord, M_PI, mrpt::nav::CAbstractHolonomicReactiveMethod::NavInput::maxRobotSpeed, min, mrpt::nav::CAbstractHolonomicReactiveMethod::NavInput::obstacles, and mrpt::nav::CAbstractHolonomicReactiveMethod::NavInput::targets.

◆ operator delete() [1/3]

void mrpt::nav::CHolonomicVFF::operator delete ( void * ptr )

inlinenoexcept

Definition at line 52 of file CHolonomicVFF.h.

◆ operator delete() [2/3]

void mrpt::nav::CHolonomicVFF::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 52 of file CHolonomicVFF.h.

◆ operator delete() [3/3]

void mrpt::nav::CHolonomicVFF::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 52 of file CHolonomicVFF.h.

◆ operator delete[]()

void mrpt::nav::CHolonomicVFF::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 52 of file CHolonomicVFF.h.

◆ operator new() [1/3]

static void* mrpt::nav::CHolonomicVFF::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 52 of file CHolonomicVFF.h.

◆ operator new() [2/3]

void* mrpt::nav::CHolonomicVFF::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 52 of file CHolonomicVFF.h.

◆ operator new() [3/3]

void* mrpt::nav::CHolonomicVFF::operator new ( size_t size )

inline

Definition at line 52 of file CHolonomicVFF.h.

◆ operator new[]()

void* mrpt::nav::CHolonomicVFF::operator new[] ( size_t size )

inline

Definition at line 52 of file CHolonomicVFF.h.

◆ readFromStream()

void CHolonomicVFF::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

overrideprotectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 117 of file CHolonomicVFF.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ saveConfigFile()

void CHolonomicVFF::saveConfigFile ( mrpt::utils::CConfigFileBase & c ) const

overridevirtual

saves all available parameters, in a forma loadable by initialize()

Implements mrpt::nav::CAbstractHolonomicReactiveMethod.

Definition at line 38 of file CHolonomicVFF.cpp.

◆ setAssociatedPTG()

void CAbstractHolonomicReactiveMethod::setAssociatedPTG ( mrpt::nav::CParameterizedTrajectoryGenerator * ptg )

inherited

Optionally, sets the associated PTG, just in case a derived class requires this info (not required for methods where the robot kinematics are totally abstracted)

Definition at line 41 of file CAbstractHolonomicReactiveMethod.cpp.

References mrpt::nav::CAbstractHolonomicReactiveMethod::m_associatedPTG.

◆ setConfigFileSectionName()

void CAbstractHolonomicReactiveMethod::setConfigFileSectionName ( const std::string & sectName )

inherited

Defines the name of the section used in initialize()

Defines the name of the section (Default: "FULL_EVAL_CONFIG")

Definition at line 31 of file CAbstractHolonomicReactiveMethod.cpp.

References mrpt::nav::CAbstractHolonomicReactiveMethod::m_cfgSectionName.

◆ setTargetApproachSlowDownDistance()

void mrpt::nav::CHolonomicVFF::setTargetApproachSlowDownDistance ( const double dist )

inlineoverridevirtual

Sets the actual value of this parameter [m].

See also: getTargetApproachSlowDownDistance()

Implements mrpt::nav::CAbstractHolonomicReactiveMethod.

Definition at line 92 of file CHolonomicVFF.h.

References options, and mrpt::nav::CHolonomicVFF::TOptions::TARGET_SLOW_APPROACHING_DISTANCE.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

void CHolonomicVFF::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

overrideprotectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If nullptr, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Definition at line 107 of file CHolonomicVFF.cpp.

Member Data Documentation

◆ _init_CHolonomicVFF

mrpt::utils::CLASSINIT mrpt::nav::CHolonomicVFF::_init_CHolonomicVFF

staticprotected

Definition at line 52 of file CHolonomicVFF.h.

◆ className

constexpr const char* mrpt::nav::CHolonomicVFF::className = "CHolonomicVFF"

static

Definition at line 52 of file CHolonomicVFF.h.

◆ m_associatedPTG

mrpt::nav::CParameterizedTrajectoryGenerator* mrpt::nav::CAbstractHolonomicReactiveMethod::m_associatedPTG

protectedinherited

If applicable, this will contain the argument of the most recent call to setAssociatedPTG()

Definition at line 129 of file CAbstractHolonomicReactiveMethod.h.

Referenced by mrpt::nav::CAbstractHolonomicReactiveMethod::getAssociatedPTG(), and mrpt::nav::CAbstractHolonomicReactiveMethod::setAssociatedPTG().

◆ m_enableApproachTargetSlowDown

bool mrpt::nav::CAbstractHolonomicReactiveMethod::m_enableApproachTargetSlowDown

protectedinherited

Whether to decrease speed when approaching target.

Definition at line 131 of file CAbstractHolonomicReactiveMethod.h.

Referenced by mrpt::nav::CAbstractHolonomicReactiveMethod::enableApproachTargetSlowDown(), and mrpt::nav::CHolonomicFullEval::navigate().

◆ options

TOptions mrpt::nav::CHolonomicVFF::options

Parameters of the algorithm (can be set manually or loaded from CHolonomicVFF::initialize or options.loadFromConfigFile(), etc.)

Definition at line 86 of file CHolonomicVFF.h.

Referenced by getTargetApproachSlowDownDistance(), and setTargetApproachSlowDownDistance().

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::nav::CHolonomicVFF::runtimeClassId

staticprotected

Definition at line 52 of file CHolonomicVFF.h.

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CHolonomicVFF()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateObject()

◆ enableApproachTargetSlowDown()

◆ Factory()

◆ getAssociatedPTG()

◆ getConfigFileSectionName()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ getTargetApproachSlowDownDistance()

◆ initialize()

◆ navigate()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ readFromStream()

◆ saveConfigFile()

◆ setAssociatedPTG()

◆ setConfigFileSectionName()

◆ setTargetApproachSlowDownDistance()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CHolonomicVFF

◆ className

◆ m_associatedPTG

◆ m_enableApproachTargetSlowDown

◆ options

◆ runtimeClassId