BipedalLocomotion::ParametersHandler::IParametersHandler class
#include <BipedalLocomotion/ParametersHandler/IParametersHandler.h>

Parameters handler interface.

Derived classes

class StdImplementation
Parameters handler interface.
class TomlImplementation
TomlImplementation Toml implementation of the IParametersHandler interface.
class YarpImplementation
YarpImplementation Yarp implementation of the IParametersHandler interface.

Public types

using unique_ptr = std::unique_ptr<IParametersHandler>
using shared_ptr = std::shared_ptr<IParametersHandler>
using weak_ptr = std::weak_ptr<IParametersHandler>

Constructors, destructors, conversion operators

~IParametersHandler() defaulted virtual
Destructor.

Public functions

auto getParameter(const std::string& parameterName, int& parameter) const -> bool pure virtual
Get a parameter [int].
auto getParameter(const std::string& parameterName, double& parameter) const -> bool pure virtual
Get a parameter [double].
auto getParameter(const std::string& parameterName, std::string& parameter) const -> bool pure virtual
Get a parameter [std::string].
auto getParameter(const std::string& parameterName, bool& parameter) const -> bool pure virtual
Get a parameter [bool].
auto getParameter(const std::string& parameterName, std::chrono::nanoseconds& parameter) const -> bool pure virtual
Get a parameter [int].
auto getParameter(const std::string& parameterName, std::vector<bool>& parameter) const -> bool pure virtual
Get a parameter [std::vector<bool>].
auto getParameter(const std::string& parameterName, GenericContainer::Vector<int>::Ref parameter) const -> bool pure virtual
Get a parameter [GenericContainer::Vector<int>].
auto getParameter(const std::string& parameterName, GenericContainer::Vector<double>::Ref parameter) const -> bool pure virtual
Get a parameter [GenericContainer::Vector<double>].
auto getParameter(const std::string& parameterName, GenericContainer::Vector<std::string>::Ref parameter) const -> bool pure virtual
Get a parameter [GenericContainer::Vector<std::string>].
auto getParameter(const std::string& parameterName, GenericContainer::Vector<std::chrono::nanoseconds>::Ref parameter) const -> bool pure virtual
Get a parameter [GenericContainer::Vector<std::chrono::nanoseconds>].
void setParameter(const std::string& parameterName, const int& parameter) pure virtual
Set a parameter [int].
void setParameter(const std::string& parameterName, const double& parameter) pure virtual
Set a parameter [double].
void setParameter(const std::string& parameterName, const std::string& parameter) pure virtual
Set a parameter [std::string].
void setParameter(const std::string& parameterName, const char* parameter) pure virtual
Set a parameter [const char*].
void setParameter(const std::string& parameterName, const bool& parameter) pure virtual
Set a parameter [bool].
void setParameter(const std::string& parameterName, const std::chrono::nanoseconds& parameter) pure virtual
Set a parameter [std::chrono::nanoseconds].
void setParameter(const std::string& parameterName, const std::vector<bool>& parameter) pure virtual
Set a parameter [std::vector<bool>].
void setParameter(const std::string& parameterName, const GenericContainer::Vector<const int>::Ref parameter) pure virtual
Set a parameter [GenericContainer::Vector<int>].
void setParameter(const std::string& parameterName, const GenericContainer::Vector<const double>::Ref parameter) pure virtual
Set a parameter [GenericContainer::Vector<double>].
void setParameter(const std::string& parameterName, const GenericContainer::Vector<const std::string>::Ref parameter) pure virtual
Set a parameter [GenericContainer::Vector<std::string>].
void setParameter(const std::string& parameterName, const GenericContainer::Vector<const std::chrono::nanoseconds>::Ref parameter) pure virtual
Get a parameter [GenericContainer::Vector<std::chrono::nanoseconds>].
auto getGroup(const std::string& name) const -> weak_ptr pure virtual
Get a Group from the handler.
auto setGroup(const std::string& name, shared_ptr newGroup) -> bool pure virtual
Set a new group on the handler.
auto toString() const -> std::string pure virtual
Return a standard text representation of the content of the object.
auto isEmpty() const -> bool pure virtual
Check if the handler contains parameters.
void clear() pure virtual
Clears the handler from all the parameters.
auto clone() const -> shared_ptr pure virtual
Clone the content of the content.

Function documentation

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, int& parameter) const pure virtual

Get a parameter [int].

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, double& parameter) const pure virtual

Get a parameter [double].

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, std::string& parameter) const pure virtual

Get a parameter [std::string].

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, bool& parameter) const pure virtual

Get a parameter [bool].

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, std::chrono::nanoseconds& parameter) const pure virtual

Get a parameter [int].

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, std::vector<bool>& parameter) const pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, GenericContainer::Vector<int>::Ref parameter) const pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, GenericContainer::Vector<double>::Ref parameter) const pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, GenericContainer::Vector<std::string>::Ref parameter) const pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

bool BipedalLocomotion::ParametersHandler::IParametersHandler::getParameter(const std::string& parameterName, GenericContainer::Vector<std::chrono::nanoseconds>::Ref parameter) const pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter
Returns true/false in case of success/failure

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const int& parameter) pure virtual

Set a parameter [int].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const double& parameter) pure virtual

Set a parameter [double].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const std::string& parameter) pure virtual

Set a parameter [std::string].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const char* parameter) pure virtual

Set a parameter [const char*].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const bool& parameter) pure virtual

Set a parameter [bool].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const std::chrono::nanoseconds& parameter) pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const std::vector<bool>& parameter) pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const GenericContainer::Vector<const int>::Ref parameter) pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const GenericContainer::Vector<const double>::Ref parameter) pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const GenericContainer::Vector<const std::string>::Ref parameter) pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::IParametersHandler::setParameter(const std::string& parameterName, const GenericContainer::Vector<const std::chrono::nanoseconds>::Ref parameter) pure virtual

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

Parameters
parameterName name of the parameter
parameter parameter

weak_ptr BipedalLocomotion::ParametersHandler::IParametersHandler::getGroup(const std::string& name) const pure virtual

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

bool BipedalLocomotion::ParametersHandler::IParametersHandler::setGroup(const std::string& name, shared_ptr newGroup) pure virtual

Set a new group on the handler.

Parameters
name name of the group
newGroup shared pointer to the new group
Returns true/false in case of success/failure

std::string BipedalLocomotion::ParametersHandler::IParametersHandler::toString() const pure virtual

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.

bool BipedalLocomotion::ParametersHandler::IParametersHandler::isEmpty() const pure virtual

Check if the handler contains parameters.

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

void BipedalLocomotion::ParametersHandler::IParametersHandler::clear() pure virtual

Clears the handler from all the parameters.

shared_ptr BipedalLocomotion::ParametersHandler::IParametersHandler::clone() const pure virtual

Clone the content of the content.

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