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

YarpImplementation Yarp implementation of the IParametersHandler interface.

Base classes

class IParametersHandler
Parameters handler interface.

Constructors, destructors, conversion operators

YarpImplementation(const yarp::os::Searchable& searchable)
Constructor.
YarpImplementation() defaulted
Constructor.
~YarpImplementation() defaulted
Destructor.

Public functions

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

Function documentation

BipedalLocomotion::ParametersHandler::YarpImplementation::YarpImplementation(const yarp::os::Searchable& searchable)

Constructor.

Parameters
searchable reference to a searchable object. The object is copied inside the Handler

void BipedalLocomotion::ParametersHandler::YarpImplementation::set(const yarp::os::Searchable& searchable)

Set the handler from an object.

Parameters
searchable The object to copy

bool BipedalLocomotion::ParametersHandler::YarpImplementation::setFromFile(const std::string& filename)

Set the handler from a file.

Parameters
filename the name of the file that should be loaded.
Returns true/false in case of success/failure.

bool BipedalLocomotion::ParametersHandler::YarpImplementation::getParameter(const std::string& parameterName, int& parameter) const final

Get a parameter [int].

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

bool BipedalLocomotion::ParametersHandler::YarpImplementation::getParameter(const std::string& parameterName, double& parameter) const final

Get a parameter [double].

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

bool BipedalLocomotion::ParametersHandler::YarpImplementation::getParameter(const std::string& parameterName, std::string& parameter) const final

Get a parameter [std::string].

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

bool BipedalLocomotion::ParametersHandler::YarpImplementation::getParameter(const std::string& parameterName, bool& parameter) const final

Get a parameter [bool].

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

bool BipedalLocomotion::ParametersHandler::YarpImplementation::getParameter(const std::string& parameterName, std::chrono::nanoseconds& parameter) const final

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

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

bool BipedalLocomotion::ParametersHandler::YarpImplementation::getParameter(const std::string& parameterName, std::vector<bool>& parameter) const final

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::YarpImplementation::getParameter(const std::string& parameterName, GenericContainer::Vector<int>::Ref parameter) const final

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::YarpImplementation::getParameter(const std::string& parameterName, GenericContainer::Vector<double>::Ref parameter) const final

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::YarpImplementation::getParameter(const std::string& parameterName, GenericContainer::Vector<std::string>::Ref parameter) const final

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::YarpImplementation::getParameter(const std::string& parameterName, GenericContainer::Vector<std::chrono::nanoseconds>::Ref parameter) const final

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::YarpImplementation::setParameter(const std::string& parameterName, const int& parameter) final

Set a parameter [int].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const double& parameter) final

Set a parameter [double].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const std::string& parameter) final

Set a parameter [std::string].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const char* parameter) final

Set a parameter [const char*].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const bool& parameter) final

Set a parameter [bool].

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const std::chrono::nanoseconds& parameter) final

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const std::vector<bool>& parameter) final

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

Parameters
parameterName name of the parameter
parameter parameter

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

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

Parameters
parameterName name of the parameter
parameter parameter

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

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

Parameters
parameterName name of the parameter
parameter parameter

void BipedalLocomotion::ParametersHandler::YarpImplementation::setParameter(const std::string& parameterName, const GenericContainer::Vector<const std::string>::Ref parameter) final

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

Parameters
parameterName name of the parameter
parameter parameter

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

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

Parameters
parameterName name of the parameter
parameter parameter

weak_ptr BipedalLocomotion::ParametersHandler::YarpImplementation::getGroup(const std::string& name) const final

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::YarpImplementation::setGroup(const std::string& name, shared_ptr newGroup) final

Set a new group on the handler.

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

std::string BipedalLocomotion::ParametersHandler::YarpImplementation::toString() const final

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::YarpImplementation::isEmpty() const final

Check if the handler contains parameters.

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

shared_ptr BipedalLocomotion::ParametersHandler::YarpImplementation::clone() const final

Clone the content of the content.

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