Parameters handler interface. More...

#include <ParametersHandler/include/BipedalLocomotion/ParametersHandler/StdImplementation.h>

Public Member Functions
	StdImplementation (const std::unordered_map< std::string, std::any > &map)
	Constructor. More...

	StdImplementation ()=default
	Constructor.

void	set (const std::unordered_map< std::string, std::any > &searchable)
	Set the handler from an object. More...

bool	getParameter (const std::string &parameterName, int &parameter) const final
	Get a parameter [int]. More...

bool	getParameter (const std::string &parameterName, double &parameter) const final
	Get a parameter [double]. More...

bool	getParameter (const std::string &parameterName, std::string &parameter) const final
	Get a parameter [std::string]. More...

bool	getParameter (const std::string &parameterName, bool &parameter) const final
	Get a parameter [bool]. More...

bool	getParameter (const std::string &parameterName, std::chrono::nanoseconds &parameter) const final
	Get a parameter [std::chrono::nanoseconds]. More...

bool	getParameter (const std::string &parameterName, std::vector< bool > &parameter) const final
	Get a parameter [std::vector<bool>]. More...

bool	getParameter (const std::string &parameterName, GenericContainer::Vector< int >::Ref parameter) const final
	Get a parameter [GenericContainer::Vector<int>]. More...

bool	getParameter (const std::string &parameterName, GenericContainer::Vector< double >::Ref parameter) const final
	Get a parameter [GenericContainer::Vector<double>]. More...

bool	getParameter (const std::string &parameterName, GenericContainer::Vector< std::string >::Ref parameter) const final
	Get a parameter [GenericContainer::Vector<std::string>]. More...

bool	getParameter (const std::string &parameterName, GenericContainer::Vector< std::chrono::nanoseconds >::Ref parameter) const final
	Get a parameter [GenericContainer::Vector<std::chrono::nanoseconds>]. More...

void	setParameter (const std::string &parameterName, const int &parameter) final
	Set a parameter [int]. More...

void	setParameter (const std::string &parameterName, const double &parameter) final
	Set a parameter [double]. More...

void	setParameter (const std::string &parameterName, const std::string &parameter) final
	Set a parameter [std::string]. More...

void	setParameter (const std::string &parameterName, const char *parameter) final
	Set a parameter [const char*]. More...

void	setParameter (const std::string &parameterName, const bool &parameter) final
	Set a parameter [bool]. More...

void	setParameter (const std::string &parameterName, const std::chrono::nanoseconds &parameter) final
	Set a parameter [std::chrono::nanoseconds]. More...

void	setParameter (const std::string &parameterName, const std::vector< bool > &parameter) final
	Set a parameter [std::vector<bool>]. More...

void	setParameter (const std::string &parameterName, const GenericContainer::Vector< const int >::Ref parameter) final
	Set a parameter [GenericContainer::Vector<int>]. More...

void	setParameter (const std::string &parameterName, const GenericContainer::Vector< const double >::Ref parameter) final
	Set a parameter [GenericContainer::Vector<double>]. More...

void	setParameter (const std::string &parameterName, const GenericContainer::Vector< const std::string >::Ref parameter) final
	Set a parameter [GenericContainer::Vector<std::string>]. More...

void	setParameter (const std::string &parameterName, const GenericContainer::Vector< const std::chrono::nanoseconds >::Ref parameter) final
	Get a parameter [GenericContainer::Vector<std::chrono::nanoseconds>]. More...

weak_ptr	getGroup (const std::string &name) const final
	Get a Group from the handler. More...

bool	setGroup (const std::string &name, shared_ptr newGroup) final
	Set a new group on the handler. More...

std::string	toString () const final
	Return a standard text representation of the content of the object. More...

bool	isEmpty () const final
	Check if the handler contains parameters. More...

void	clear () final
	Clears the handler from all the parameters.

shared_ptr	clone () const final
	Clone the content of the content. More...

Public Member Functions inherited from BipedalLocomotion::ParametersHandler::IParametersHandler
virtual	~IParametersHandler ()=default
	Destructor.

Additional Inherited Members
Public Types inherited from BipedalLocomotion::ParametersHandler::IParametersHandler
using	unique_ptr = std::unique_ptr< IParametersHandler >

using	shared_ptr = std::shared_ptr< IParametersHandler >

using	weak_ptr = std::weak_ptr< IParametersHandler >

Detailed Description

Parameters handler interface.

Constructor & Destructor Documentation

◆ StdImplementation()

BipedalLocomotion::ParametersHandler::StdImplementation::StdImplementation ( const std::unordered_map< std::string, std::any > & map )

inline

Constructor.

Parameters

map	reference to a map object. The object is copied inside the Handler

Member Function Documentation

◆ set()

void StdImplementation::set ( const std::unordered_map< std::string, std::any > & searchable )

Set the handler from an object.

Parameters

object The object to copy

◆ getParameter() [1/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		int &	parameter
	)		const

finalvirtual

Get a parameter [int].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [2/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		double &	parameter
	)		const

finalvirtual

Get a parameter [double].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [3/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		std::string &	parameter
	)		const

finalvirtual

Get a parameter [std::string].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [4/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		bool &	parameter
	)		const

finalvirtual

Get a parameter [bool].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [5/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		std::chrono::nanoseconds &	parameter
	)		const

finalvirtual

Get a parameter [std::chrono::nanoseconds].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [6/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		std::vector< bool > &	parameter
	)		const

finalvirtual

Get a parameter [std::vector<bool>].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [7/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		GenericContainer::Vector< int >::Ref	parameter
	)		const

finalvirtual

Get a parameter [GenericContainer::Vector<int>].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [8/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		GenericContainer::Vector< double >::Ref	parameter
	)		const

finalvirtual

Get a parameter [GenericContainer::Vector<double>].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [9/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		GenericContainer::Vector< std::string >::Ref	parameter
	)		const

finalvirtual

Get a parameter [GenericContainer::Vector<std::string>].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getParameter() [10/10]

bool StdImplementation::getParameter	(	const std::string &	parameterName,
		GenericContainer::Vector< std::chrono::nanoseconds >::Ref	parameter
	)		const

finalvirtual

Get a parameter [GenericContainer::Vector<std::chrono::nanoseconds>].

Parameters

parameterName	name of the parameter
parameter	parameter

Returns: true/false in case of success/failure

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [1/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const int &	parameter
	)

finalvirtual

Set a parameter [int].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [2/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const double &	parameter
	)

finalvirtual

Set a parameter [double].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [3/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const std::string &	parameter
	)

finalvirtual

Set a parameter [std::string].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [4/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const char *	parameter
	)

finalvirtual

Set a parameter [const char*].

Note: this is required because of https://www.bfilipek.com/2019/07/surprising-conversions-char-bool.html

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [5/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const bool &	parameter
	)

finalvirtual

Set a parameter [bool].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [6/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const std::chrono::nanoseconds &	parameter
	)

finalvirtual

Set a parameter [std::chrono::nanoseconds].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [7/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const std::vector< bool > &	parameter
	)

finalvirtual

Set a parameter [std::vector<bool>].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [8/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const GenericContainer::Vector< const int >::Ref	parameter
	)

finalvirtual

Set a parameter [GenericContainer::Vector<int>].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [9/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const GenericContainer::Vector< const double >::Ref	parameter
	)

finalvirtual

Set a parameter [GenericContainer::Vector<double>].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [10/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const GenericContainer::Vector< const std::string >::Ref	parameter
	)

finalvirtual

Set a parameter [GenericContainer::Vector<std::string>].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setParameter() [11/11]

void StdImplementation::setParameter	(	const std::string &	parameterName,
		const GenericContainer::Vector< const std::chrono::nanoseconds >::Ref	parameter
	)

finalvirtual

Get a parameter [GenericContainer::Vector<std::chrono::nanoseconds>].

Parameters

parameterName	name of the parameter
parameter	parameter

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ getGroup()

IParametersHandler::weak_ptr StdImplementation::getGroup ( const std::string & name ) const

finalvirtual

Get a Group from the handler.

Parameters

name	name of the group

Returns: A pointer to IParametersHandler, if the group is not found the weak pointer cannot be locked

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ setGroup()

bool StdImplementation::setGroup	(	const std::string &	name,
		IParametersHandler::shared_ptr	newGroup
	)

finalvirtual

Set a new group on the handler.

Parameters

name	name of the group
newGroup	shared pointer to the new group

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ toString()

std::string StdImplementation::toString ( ) const

finalvirtual

Return a standard text representation of the content of the object.

Returns: a string containing the standard text representation of the content of the object.

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ isEmpty()

bool StdImplementation::isEmpty ( ) const

finalvirtual

Check if the handler contains parameters.

Returns: true if the handler does not contain any parameters, false otherwise

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

◆ clone()

IParametersHandler::shared_ptr StdImplementation::clone ( ) const

finalvirtual

Clone the content of the content.

Returns: a IParametersHandler::shared_ptr clone of the current handler.

Implements BipedalLocomotion::ParametersHandler::IParametersHandler.

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

ParametersHandler/include/BipedalLocomotion/ParametersHandler/StdImplementation.h
ParametersHandler/src/StdImplementation.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StdImplementation()

Member Function Documentation

◆ set()

◆ getParameter() [1/10]

◆ getParameter() [2/10]

◆ getParameter() [3/10]

◆ getParameter() [4/10]

◆ getParameter() [5/10]

◆ getParameter() [6/10]

◆ getParameter() [7/10]

◆ getParameter() [8/10]

◆ getParameter() [9/10]

◆ getParameter() [10/10]

◆ setParameter() [1/11]

◆ setParameter() [2/11]

◆ setParameter() [3/11]

◆ setParameter() [4/11]

◆ setParameter() [5/11]

◆ setParameter() [6/11]

◆ setParameter() [7/11]

◆ setParameter() [8/11]

◆ setParameter() [9/11]

◆ setParameter() [10/11]

◆ setParameter() [11/11]

◆ getGroup()

◆ setGroup()

◆ toString()

◆ isEmpty()

◆ clone()