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 47 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
	CHolonomicVFF (const mrpt::config::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::config::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...

void	saveConfigFile (mrpt::config::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 for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	duplicateGetSmartPtr () const
	Makes a deep copy of the object and returns a smart pointer to it. More...

Static Public Member Functions
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
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...

void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...

void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...

CSerializable virtual methods
virtual void	serializeTo (CSchemeArchiveBase &out) const
	Virtual method for writing (serializing) to an abstract schema based archive. More...

virtual void	serializeFrom (CSchemeArchiveBase &in)
	Virtual method for reading (deserializing) from an abstract schema based archive. 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< mrpt::nav ::CHolonomicVFF >

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

using	UniquePtr = std::unique_ptr< mrpt::nav ::CHolonomicVFF >

using	ConstUniquePtr = std::unique_ptr< const mrpt::nav ::CHolonomicVFF >

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

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

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

static constexpr auto	getClassName ()

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

static std::shared_ptr< CObject >	CreateObject ()

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

template<typename Alloc , typename... Args>
static Ptr	CreateAlloc (const Alloc &alloc, Args &&... args)

template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)

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

virtual mrpt::rtti::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 mrpt::nav :: CHolonomicVFF >

Definition at line 49 of file CHolonomicVFF.h.

◆ ConstUniquePtr

using mrpt::nav::CHolonomicVFF::ConstUniquePtr = std::unique_ptr<const mrpt::nav :: CHolonomicVFF >

Definition at line 49 of file CHolonomicVFF.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 49 of file CHolonomicVFF.h.

◆ UniquePtr

using mrpt::nav::CHolonomicVFF::UniquePtr = std::unique_ptr< mrpt::nav :: CHolonomicVFF >

Definition at line 49 of file CHolonomicVFF.h.

Constructor & Destructor Documentation

◆ CHolonomicVFF()

mrpt::nav::CHolonomicVFF::CHolonomicVFF ( const mrpt::config::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::rtti::TRuntimeClassId* mrpt::nav::CHolonomicVFF::_GetBaseClass ( )

staticprotected

◆ clone()

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

overridevirtual

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

Implements mrpt::rtti::CObject.

◆ Create() [1/2]

template<typename... Args>

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

inlinestatic

Definition at line 49 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.

◆ CreateAlloc()

template<typename Alloc , typename... Args>

static Ptr mrpt::nav::CHolonomicVFF::CreateAlloc	(	const Alloc &	alloc,
		Args &&...	args
	)

inlinestatic

Definition at line 49 of file CHolonomicVFF.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::nav::CHolonomicVFF::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::nav::CHolonomicVFF::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 49 of file CHolonomicVFF.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 204 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableApproachTargetSlowDown()

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

inlineinherited

Definition at line 119 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 51 of file CAbstractHolonomicReactiveMethod.cpp.

References mrpt::rtti::TRuntimeClassId::createObject(), mrpt::rtti::findRegisteredClass(), mrpt::ptr_cast< CAST_TO >::from(), and mrpt::rtti::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 46 of file CAbstractHolonomicReactiveMethod.cpp.

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

◆ getClassName()

static constexpr auto mrpt::nav::CHolonomicVFF::getClassName ( )

inlinestatic

Definition at line 49 of file CHolonomicVFF.h.

◆ getConfigFileSectionName()

std::string CAbstractHolonomicReactiveMethod::getConfigFileSectionName ( ) const

inherited

Gets the name of the section used in initialize()

Definition at line 35 of file CAbstractHolonomicReactiveMethod.cpp.

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

◆ GetRuntimeClass()

virtual const mrpt::rtti::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::rtti::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 85 of file CHolonomicVFF.h.

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

◆ initialize()

void CHolonomicVFF::initialize ( const mrpt::config::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 32 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 44 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, mrpt::nav::CAbstractHolonomicReactiveMethod::NavInput::obstacles, and mrpt::nav::CAbstractHolonomicReactiveMethod::NavInput::targets.

◆ saveConfigFile()

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

overridevirtual

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

Implements mrpt::nav::CAbstractHolonomicReactiveMethod.

Definition at line 36 of file CHolonomicVFF.cpp.

◆ serializeFrom() [1/2]

void CHolonomicVFF::serializeFrom	(	mrpt::serialization::CArchive &	in,
		uint8_t	serial_version
	)

overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 111 of file CHolonomicVFF.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION.

◆ serializeFrom() [2/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase & in )

inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeGetVersion()

uint8_t CHolonomicVFF::serializeGetVersion ( ) const

overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 105 of file CHolonomicVFF.cpp.

◆ serializeTo() [1/2]

void CHolonomicVFF::serializeTo ( mrpt::serialization::CArchive & out ) const

overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 106 of file CHolonomicVFF.cpp.

References out.

◆ serializeTo() [2/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase & out ) const

inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ 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 40 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 30 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 89 of file CHolonomicVFF.h.

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

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::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 90 of file CSerializable.h.

Member Data Documentation

◆ className

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

static

Definition at line 49 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 127 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 129 of file CAbstractHolonomicReactiveMethod.h.

Referenced by mrpt::nav::CAbstractHolonomicReactiveMethod::enableApproachTargetSlowDown().

◆ 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 83 of file CHolonomicVFF.h.

Referenced by getTargetApproachSlowDownDistance(), and setTargetApproachSlowDownDistance().

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::nav::CHolonomicVFF::runtimeClassId

staticprotected

Definition at line 49 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

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CHolonomicVFF()

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateAlloc()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ enableApproachTargetSlowDown()

◆ Factory()

◆ getAssociatedPTG()

◆ getClassName()

◆ getConfigFileSectionName()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ getTargetApproachSlowDownDistance()

◆ initialize()

◆ navigate()

◆ saveConfigFile()

◆ serializeFrom() [1/2]

◆ serializeFrom() [2/2]

◆ serializeGetVersion()

◆ serializeTo() [1/2]

◆ serializeTo() [2/2]

◆ setAssociatedPTG()

◆ setConfigFileSectionName()

◆ setTargetApproachSlowDownDistance()

◆ writeToMatlab()

Member Data Documentation

◆ className

◆ m_associatedPTG

◆ m_enableApproachTargetSlowDown

◆ options

◆ runtimeClassId