Clase Pds::CmdHelp

Clase que implementa metodos para crear mensajes de ayuda por consola. Más...

Namespaces
namespace	Pds
	Nombre de espacio para Pds (Procesamiento Digital de Senales)

Estructuras de datos
class	Pds::CmdHelp
	La estructura tipo Pds::CmdHelp . Esta estructura genera una posicion. Para usar incluir <Pds/CmdHelp>. Más...

Varios tipos de constructores
Crean una objeto Pds::CmdHelp
	Pds::CmdHelp::CmdHelp (void)
	Crea un objeto de tipo Pds::CmdHelp. Más...
	Pds::CmdHelp::CmdHelp (const std::string &program, const std::string &version)
	Crea un objeto de tipo Pds::CmdHelp. Más...
	Pds::CmdHelp::~CmdHelp ()

Métodos para ptrabajar con Pds::CmdHelp
Crean una objeto Pds::CmdHelp
bool	Pds::CmdHelp::AddParam (const unsigned int &ptype, const std::string &plong, const std::string &pshort, const std::string &description, const std::string &bydefault="")
	Agrega datos de parámetros del programa. Más...
bool	Pds::CmdHelp::SetCommandExample (const std::string &commandexample)
	Coloca un exemplo de uso del programa. Más...
bool	Pds::CmdHelp::SetAbstract (const std::string &abstract)
	Escribe el abstract. Más...
bool	Pds::CmdHelp::IsEmpty (void) const
	Retorna true si el objeto está inicializado o false si no. Más...
bool	Pds::CmdHelp::Print (void) const
	Imprime por consola el help del programa. Más...

Descripción detallada

Clase que implementa metodos para crear mensajes de ayuda por consola.

#include <Pds/CmdHelp>

Documentación de las funciones

CmdHelp() [1/2]

Pds::CmdHelp::CmdHelp

(

void

)

Crea un objeto de tipo Pds::CmdHelp.

CmdHelp() [2/2]

Pds::CmdHelp::CmdHelp	(	const std::string &	program,
		const std::string &	version
	)

Crea un objeto de tipo Pds::CmdHelp.

Parámetros

[in]	program	Nombre del programa.
[in]	version	Version del programa.

AddParam()

bool Pds::CmdHelp::AddParam	(	const unsigned int &	ptype,
		const std::string &	plong,
		const std::string &	pshort,
		const std::string &	description,
		const std::string &	bydefault = ""
	)

Agrega datos de parámetros del programa.

Parámetros

[in]	ptype	Tipo de parámetro. 0 indica parámetro sin dato, 1 parámetro con dato.
[in]	plong	Parametro en formato largo.
[in]	pshort	Parametro en formato corto.
[in]	description	Descripción del parámetro.
[in]	bydefault	Valor por defecto del parámetro.

Devuelve

Retorna true si todo fue bien o false si no.

Ejemplos

example_cmdhelp.cpp.

SetCommandExample()

bool Pds::CmdHelp::SetCommandExample

(

const std::string &

commandexample

)

Coloca un exemplo de uso del programa.

Parámetros

[in]

commandexample

Comando de exemplo de uso del programa.

Devuelve

Retorna true si el objeto está inicializado o false si no.

Ejemplos

example_cmdhelp.cpp.

SetAbstract()

bool Pds::CmdHelp::SetAbstract

(

const std::string &

abstract

)

Escribe el abstract.

Parámetros

[in]

abstract

Resumen del programa.

Devuelve

Retorna true si el objeto está inicializado o false si no.

Ejemplos

example_cmdhelp.cpp.

IsEmpty()

bool Pds::CmdHelp::IsEmpty

(

void

)

const

Retorna true si el objeto está inicializado o false si no.

Devuelve

Retorna true si el objeto está inicializado o false si no.

Print()

bool Pds::CmdHelp::Print

(

void

)

const

Imprime por consola el help del programa.

Devuelve

Retorna true si el objeto está inicializado o false si no.

Ejemplos

example_cmdhelp.cpp.

~CmdHelp()

Pds::CmdHelp::~CmdHelp

(

)