FrameGrabber_nwc_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:40 2025
 
 
#include "FrameGrabber_nwc_yarp_ParamsParser.h"
#include <yarp/os/LogStream.h>
#include <yarp/os/Value.h>
 
namespace {
    YARP_LOG_COMPONENT(FrameGrabber_nwc_yarpParamsCOMPONENT, "yarp.device.FrameGrabber_nwc_yarp")
}
 
 
FrameGrabber_nwc_yarp_ParamsParser::FrameGrabber_nwc_yarp_ParamsParser()
{
}
 
 
std::vector<std::string> FrameGrabber_nwc_yarp_ParamsParser::getListOfParams() const
{
    std::vector<std::string> params;
    params.push_back("local");
    params.push_back("remote");
    params.push_back("carrier");
    params.push_back("no_stream");
    return params;
}
 
 
bool FrameGrabber_nwc_yarp_ParamsParser::getParamValue(const std::string& paramName, std::string& paramValue) const
{
    if (paramName =="local")
    {
        paramValue = m_local;
        return true;
    }
    if (paramName =="remote")
    {
        paramValue = m_remote;
        return true;
    }
    if (paramName =="carrier")
    {
        paramValue = m_carrier;
        return true;
    }
    if (paramName =="no_stream")
    {
        if (m_no_stream==true) paramValue = "true";
        else paramValue = "false";
        return true;
    }
 
    yError() <<"parameter '" << paramName << "' was not found";
    return false;
 
}
 
 
std::string FrameGrabber_nwc_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      FrameGrabber_nwc_yarp_ParamsParser::parseParams(const yarp::os::Searchable & config)
{
    //Check for --help option
    if (config.check("help"))
    {
        yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << getDocumentationOfDeviceParams();
    }
 
    m_provided_configuration = config.toString();
    yarp::os::Property prop_check(m_provided_configuration.c_str());
    //Parser of parameter local
    {
        if (config.check("local"))
        {
            m_local = config.find("local").asString();
            yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Parameter 'local' using value:" << m_local;
        }
        else
        {
            yCError(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Mandatory parameter 'local' not found!";
            yCError(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Description of the parameter: Prefix of the ports opened locally by the nwc for streaming and rpc operations";
            return false;
        }
        prop_check.unput("local");
    }
 
    //Parser of parameter remote
    {
        if (config.check("remote"))
        {
            m_remote = config.find("remote").asString();
            yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Parameter 'remote' using value:" << m_remote;
        }
        else
        {
            yCError(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Mandatory parameter 'remote' not found!";
            yCError(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Description of the parameter: Name of the remote rpc port opened by the nws";
            return false;
        }
        prop_check.unput("remote");
    }
 
    //Parser of parameter carrier
    {
        if (config.check("carrier"))
        {
            m_carrier = config.find("carrier").asString();
            yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Parameter 'carrier' using value:" << m_carrier;
        }
        else
        {
            yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Parameter 'carrier' using DEFAULT value:" << m_carrier;
        }
        prop_check.unput("carrier");
    }
 
    //Parser of parameter no_stream
    {
        if (config.check("no_stream"))
        {
            m_no_stream = config.find("no_stream").asBool();
            yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Parameter 'no_stream' using value:" << m_no_stream;
        }
        else
        {
            yCInfo(FrameGrabber_nwc_yarpParamsCOMPONENT) << "Parameter 'no_stream' using DEFAULT value:" << m_no_stream;
        }
        prop_check.unput("no_stream");
    }
 
    /*
    //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(FrameGrabber_nwc_yarpParamsCOMPONENT) << "User asking for parameter: "<<it->name <<" which is unknown to this parser!";
                extra_params_found = true;
            }
            else
            {
                yCWarning(FrameGrabber_nwc_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      FrameGrabber_nwc_yarp_ParamsParser::getDocumentationOfDeviceParams() const
{
    std::string doc;
    doc = doc + std::string("\n=============================================\n");
    doc = doc + std::string("This is the help for device: FrameGrabber_nwc_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("'local': Prefix of the ports opened locally by the nwc for streaming and rpc operations\n");
    doc = doc + std::string("'remote': Name of the remote rpc port opened by the nws\n");
    doc = doc + std::string("'carrier': Protocol used for connection with the nws streaming port\n");
    doc = doc + std::string("'no_stream': Full port name of the port remotely opened by the Navigation server, to which the Navigation2D_nwc_yarp connects to.\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 frameGrabber_nwc_yarp --local <mandatory_value> --remote <mandatory_value> --carrier fast_tcp --no_stream false\n";
    doc = doc + std::string("Using only mandatory params:\n");
    doc = doc + " yarpdev --device frameGrabber_nwc_yarp --local <mandatory_value> --remote <mandatory_value>\n";
    doc = doc + std::string("=============================================\n\n");    return doc;
}