Localization2D_nws_yarp_ParamsParser.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */
 
 
// Generated by yarpDeviceParamParserGenerator (2.0)
// This is an automatically generated file. Please do not edit it.
// It will be re-generated if the cmake flag ALLOW_DEVICE_PARAM_PARSER_GERNERATION is ON.
 
// Generated on: Thu May 22 11:32:42 2025
 
 
#include "Localization2D_nws_yarp_ParamsParser.h"
#include <yarp/os/LogStream.h>
#include <yarp/os/Value.h>
 
namespace {
    YARP_LOG_COMPONENT(Localization2D_nws_yarpParamsCOMPONENT, "yarp.device.Localization2D_nws_yarp")
}
 
 
Localization2D_nws_yarp_ParamsParser::Localization2D_nws_yarp_ParamsParser()
{
}
 
 
std::vector<std::string> Localization2D_nws_yarp_ParamsParser::getListOfParams() const
{
    std::vector<std::string> params;
    params.push_back("GENERAL::period");
    params.push_back("GENERAL::retrieve_position_periodically");
    params.push_back("GENERAL::name");
    params.push_back("GENERAL::publish_odometry");
    params.push_back("GENERAL::publish_location");
    return params;
}
 
 
bool Localization2D_nws_yarp_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
{
    if (paramName =="GENERAL::period")
    {
        paramValue = std::to_string(m_GENERAL_period);
        return true;
    }
    if (paramName =="GENERAL::retrieve_position_periodically")
    {
        if (m_GENERAL_retrieve_position_periodically==true) paramValue = "true";
        else paramValue = "false";
        return true;
    }
    if (paramName =="GENERAL::name")
    {
        paramValue = m_GENERAL_name;
        return true;
    }
    if (paramName =="GENERAL::publish_odometry")
    {
        if (m_GENERAL_publish_odometry==true) paramValue = "true";
        else paramValue = "false";
        return true;
    }
    if (paramName =="GENERAL::publish_location")
    {
        if (m_GENERAL_publish_location==true) paramValue = "true";
        else paramValue = "false";
        return true;
    }
 
    yError() <<"parameter '" << paramName << "' was not found";
    return false;
 
}
 
 
std::string Localization2D_nws_yarp_ParamsParser::getConfiguration() const
{
    //This is a sub-optimal solution.
    //Ideally getConfiguration() should return all parameters but it is currently
    //returning only user provided parameters (excluding default values)
    //This behaviour will be fixed in the near future.
    std::string s_cfg = m_provided_configuration;
    return s_cfg;
}
 
bool      Localization2D_nws_yarp_ParamsParser::parseParams(const yarp::os::Searchable & config)
{
    //Check for --help option
    if (config.check("help"))
    {
        yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << getDocumentationOfDeviceParams();
    }
 
    m_provided_configuration = config.toString();
    yarp::os::Property prop_check(m_provided_configuration.c_str());
    //Parser of parameter GENERAL::period
    {
        yarp::os::Bottle sectionp;
        sectionp = config.findGroup("GENERAL");
        if (sectionp.check("period"))
        {
            m_GENERAL_period = sectionp.find("period").asFloat64();
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::period' using value:" << m_GENERAL_period;
        }
        else
        {
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::period' using DEFAULT value:" << m_GENERAL_period;
        }
        prop_check.unput("GENERAL::period");
    }
 
    //Parser of parameter GENERAL::retrieve_position_periodically
    {
        yarp::os::Bottle sectionp;
        sectionp = config.findGroup("GENERAL");
        if (sectionp.check("retrieve_position_periodically"))
        {
            m_GENERAL_retrieve_position_periodically = sectionp.find("retrieve_position_periodically").asBool();
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::retrieve_position_periodically' using value:" << m_GENERAL_retrieve_position_periodically;
        }
        else
        {
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::retrieve_position_periodically' using DEFAULT value:" << m_GENERAL_retrieve_position_periodically;
        }
        prop_check.unput("GENERAL::retrieve_position_periodically");
    }
 
    //Parser of parameter GENERAL::name
    {
        yarp::os::Bottle sectionp;
        sectionp = config.findGroup("GENERAL");
        if (sectionp.check("name"))
        {
            m_GENERAL_name = sectionp.find("name").asString();
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::name' using value:" << m_GENERAL_name;
        }
        else
        {
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::name' using DEFAULT value:" << m_GENERAL_name;
        }
        prop_check.unput("GENERAL::name");
    }
 
    //Parser of parameter GENERAL::publish_odometry
    {
        yarp::os::Bottle sectionp;
        sectionp = config.findGroup("GENERAL");
        if (sectionp.check("publish_odometry"))
        {
            m_GENERAL_publish_odometry = sectionp.find("publish_odometry").asBool();
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::publish_odometry' using value:" << m_GENERAL_publish_odometry;
        }
        else
        {
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::publish_odometry' using DEFAULT value:" << m_GENERAL_publish_odometry;
        }
        prop_check.unput("GENERAL::publish_odometry");
    }
 
    //Parser of parameter GENERAL::publish_location
    {
        yarp::os::Bottle sectionp;
        sectionp = config.findGroup("GENERAL");
        if (sectionp.check("publish_location"))
        {
            m_GENERAL_publish_location = sectionp.find("publish_location").asBool();
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::publish_location' using value:" << m_GENERAL_publish_location;
        }
        else
        {
            yCInfo(Localization2D_nws_yarpParamsCOMPONENT) << "Parameter 'GENERAL::publish_location' using DEFAULT value:" << m_GENERAL_publish_location;
        }
        prop_check.unput("GENERAL::publish_location");
    }
 
    /*
    //This code check if the user set some parameter which are not check by the parser
    //If the parser is set in strict mode, this will generate an error
    if (prop_check.size() > 0)
    {
        bool extra_params_found = false;
        for (auto it=prop_check.begin(); it!=prop_check.end(); it++)
        {
            if (m_parser_is_strict)
            {
                yCError(Localization2D_nws_yarpParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
                extra_params_found = true;
            }
            else
            {
                yCWarning(Localization2D_nws_yarpParamsCOMPONENT) << "User asking for parameter: "<< it->name <<" which is unknown to this parser!";
            }
        }
 
       if (m_parser_is_strict && extra_params_found)
       {
           return false;
       }
    }
    */
    return true;
}
 
 
std::string      Localization2D_nws_yarp_ParamsParser::getDocumentationOfDeviceParams() const
{
    std::string doc;
    doc = doc + std::string("\n=============================================\n");
    doc = doc + std::string("This is the help for device: Localization2D_nws_yarp\n");
    doc = doc + std::string("\n");
    doc = doc + std::string("This is the list of the parameters accepted by the device:\n");
    doc = doc + std::string("'GENERAL::period': The period of the working thread\n");
    doc = doc + std::string("'GENERAL::retrieve_position_periodically': If true, the subdevice is asked periodically to retrieve the current location. Otherwise the current location is obtained asynchronously when a getCurrentPosition() command is issued.\n");
    doc = doc + std::string("'GENERAL::name': The name of the server, used as a prefix for the opened ports\n");
    doc = doc + std::string("'GENERAL::publish_odometry': Periodically publish odometry data over the network\n");
    doc = doc + std::string("'GENERAL::publish_location': PEriodically publish location data over the network\n");
    doc = doc + std::string("\n");
    doc = doc + std::string("Here are some examples of invocation command with yarpdev, with all params:\n");
    doc = doc + " yarpdev --device localization2D_nws_yarp --GENERAL::period 0.01 --GENERAL::retrieve_position_periodically true --GENERAL::name /localization2D_nws_yarp --GENERAL::publish_odometry true --GENERAL::publish_location true\n";
    doc = doc + std::string("Using only mandatory params:\n");
    doc = doc + " yarpdev --device localization2D_nws_yarp\n";
    doc = doc + std::string("=============================================\n\n");    return doc;
}