Funciones Pds::Ra – Arguments

Funciones para trabajar con arc y argv: Pds::Ra::ExistArgument(), etc. Más...

Namespaces
namespace	Pds
	Nombre de espacio para Pds (Procesamiento Digital de Senales)
namespace	Pds::Ra
	Nombre de espacio para RA (Real Arrays)

Trabajar con argumentos de entrada en linea de comandos
Salva datos de matrices
std::string	Pds::Ra::GetStringArgument (int argc, char *const argv[], const std::string &param, const std::string &default_data)
	Obtiene el dato de tipo std::string que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero. Más...
std::string	Pds::Ra::GetStringArgument (int argc, char *const argv[], const std::string &param_long, const std::string &param_short, const std::string &default_data)
	Obtiene el dato de tipo std::string que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero. Más...
int	Pds::Ra::GetIntArgument (int argc, char *const argv[], const std::string &param, int default_data)
	Obtiene el dato de tipo int que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero. Más...
bool	Pds::Ra::ExistArgument (int argc, char *const argv[], const std::string &param)
	Retorna true si existe el parámetro param. Más...
bool	Pds::Ra::ExistArgument (int argc, char *const argv[], const std::string &param_long, const std::string &param_short)
	Retorna true si existe el parámetro param. Más...

Descripción detallada

Funciones para trabajar con arc y argv: Pds::Ra::ExistArgument(), etc.

#include <Pds/RaArguments>

Documentación de las funciones

GetStringArgument() [1/2]

std::string Pds::Ra::GetStringArgument	(	int	argc,
		char *const	argv[],
		const std::string &	param,
		const std::string &	default_data
	)

Obtiene el dato de tipo std::string que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero.

Código de ejemplo.cpp:

int main(int argc, char *argv[])
{
    std::string default_data="/home/user/data.dat";
    std::string data=Pds::Ra::GetStringArgument(argc,argv,"--input-file",default_data);
    std::cout<<data<<std::endl;
}

Si ejecutamos:

./ejemplo --input-file "/home/mariano/readme.txt"

Obtenemos:

/home/mariano/readme.txt

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param	Parametro a buscar en las cadenas argv.
[in]	default_data	Dato por defecto.

Devuelve

El dato correspondiente ou default_data.

Ejemplos

example_cmdhelp.cpp y example_ra_arguments.cpp.

GetStringArgument() [2/2]

std::string Pds::Ra::GetStringArgument	(	int	argc,
		char *const	argv[],
		const std::string &	param_long,
		const std::string &	param_short,
		const std::string &	default_data
	)

Obtiene el dato de tipo std::string que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero.

Código de ejemplo.cpp:

int main(int argc, char *argv[])
{
    std::string default_data="/home/user/data.dat";
    std::string data=Pds::Ra::GetStringArgument(argc,argv,"--input-file","-i",default_data);
    std::cout<<data<<std::endl;
}

Si ejecutamos:

./ejemplo -i "/home/mariano/readme.txt"

Obtenemos:

/home/mariano/readme.txt

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param_long	Parametro largo a buscar en las cadenas argv.
[in]	param_short	Parametro corto a buscar en las cadenas argv.
[in]	default_data	Dato por defecto.

Devuelve

El dato correspondiente ou default_data.

GetIntArgument()

int Pds::Ra::GetIntArgument	(	int	argc,
		char *const	argv[],
		const std::string &	param,
		int	default_data
	)

Obtiene el dato de tipo int que va después del parámetro param en una cadena de parámetros argv de argc elementos. si el parámetro param no es encontrado la función retorna default_data. Si existen parámetros data repetidos, solo se atiende al primero.

Código de ejemplo.cpp:

int main(int argc, char *argv[])
{
    int default_data=256;
    int data=Pds::Ra::GetIntArgument(argc,argv,"--dat",default_data);
    std::cout<<data<<std::endl;
}

Si ejecutamos:

./ejemplo --dat 100

Obtenemos:

100

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param	Parametro a buscar en las cadenas argv.
[in]	default_data	Dato por defecto.

Devuelve

El dato correspondiente ou default_data.

Ejemplos

example_ra_arguments.cpp.

ExistArgument() [1/2]

bool Pds::Ra::ExistArgument	(	int	argc,
		char *const	argv[],
		const std::string &	param
	)

Retorna true si existe el parámetro param.

Código de ejemplo.cpp:

int main(int argc, char *argv[])
{
    if(Pds::Ra::ExistArgument(argc,argv,"--verbose"))
        std::cout<<"   Exist the param: --verbose"<<std::endl;
    else
        std::cout<<"NO exist the param: --verbose"<<std::endl;
}

Si ejecutamos:

./ejemplo --verbose

Obtenemos:

   Exist the param: --verbose

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param	Dato a buscar en las cadenas argv.

Devuelve

Retorna true si todo fue bien o false si no.

Ejemplos

example_ra_arguments.cpp.

ExistArgument() [2/2]

bool Pds::Ra::ExistArgument	(	int	argc,
		char *const	argv[],
		const std::string &	param_long,
		const std::string &	param_short
	)

Retorna true si existe el parámetro param.

Código de ejemplo.cpp:

int main(int argc, char *argv[])
{
    if(Pds::Ra::ExistArgument(argc,argv,"--verbose","-e"))
        std::cout<<"   Exist the param: --verbose"<<std::endl;
    else
        std::cout<<"NO exist the param: --verbose"<<std::endl;
}

Si ejecutamos:

./ejemplo -e

Obtenemos:

   Exist the param: --verbose

Parámetros

[in]	argc	Cantidad de elementos de argv.
[in]	argv	Cadenas de caracteres con parámetros de entrada.
[in]	param_long	Parametro largo a buscar en las cadenas argv.
[in]	param_short	Parametro corto a buscar en las cadenas argv.

Devuelve

Retorna true si todo fue bien o false si no.