Referencia de la Clase Pds::CmdHelp

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

#include <CmdHelp.hpp>

Diagrama de colaboración para Pds::CmdHelp:

Métodos públicos
Varios tipos de constructores
Crean una objeto Pds::CmdHelp
	CmdHelp (void)
	Crea un objeto de tipo Pds::CmdHelp. Más...
	CmdHelp (const std::string &program, const std::string &version)
	Crea un objeto de tipo Pds::CmdHelp. Más...
	~CmdHelp ()
Métodos para ptrabajar con Pds::CmdHelp
Crean una objeto Pds::CmdHelp
bool	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	SetCommandExample (const std::string &commandexample)
	Coloca un exemplo de uso del programa. Más...
bool	SetAbstract (const std::string &abstract)
	Escribe el abstract. Más...
bool	IsEmpty (void) const
	Retorna true si el objeto está inicializado o false si no. Más...
bool	Print (void) const
	Imprime por consola el help del programa. Más...

Atributos privados
std::string	program
std::string	version
std::string	abstract
std::string	commandexample
std::vector< Pds::HelpParamRow >	data
std::string	titleprogram
std::string	titleversion
std::string	titleabstract
std::string	titlecommand
std::string	titleparameters
std::string	titlelong
std::string	titleshort
std::string	titledescription
std::string	titledata
std::string	titledefault
std::string	textdata

Descripción detallada

La estructura tipo Pds::CmdHelp . Esta estructura genera una posicion. Para usar incluir <Pds/CmdHelp>.

Autor

Fernando Pujaico Rivera

Ejemplos

example_cmdhelp.cpp.

Definición en la línea 68 del archivo CmdHelp.hpp.

Documentación de los campos

program

std::string Pds::CmdHelp::program

private

Nombre del programa

Definición en la línea 72 del archivo CmdHelp.hpp.

version

std::string Pds::CmdHelp::version

private

Version del programa

Definición en la línea 75 del archivo CmdHelp.hpp.

abstract

std::string Pds::CmdHelp::abstract

private

Abstract del programa

Definición en la línea 78 del archivo CmdHelp.hpp.

commandexample

std::string Pds::CmdHelp::commandexample

private

Comando de ejemplo

Definición en la línea 81 del archivo CmdHelp.hpp.

data

std::vector<Pds::HelpParamRow> Pds::CmdHelp::data

private

Datos de los parámetros

Definición en la línea 84 del archivo CmdHelp.hpp.

titleprogram

std::string Pds::CmdHelp::titleprogram

private

Definición en la línea 86 del archivo CmdHelp.hpp.

titleversion

std::string Pds::CmdHelp::titleversion

private

Definición en la línea 87 del archivo CmdHelp.hpp.

titleabstract

std::string Pds::CmdHelp::titleabstract

private

Definición en la línea 88 del archivo CmdHelp.hpp.

titlecommand

std::string Pds::CmdHelp::titlecommand

private

Definición en la línea 89 del archivo CmdHelp.hpp.

titleparameters

std::string Pds::CmdHelp::titleparameters

private

Definición en la línea 90 del archivo CmdHelp.hpp.

titlelong

std::string Pds::CmdHelp::titlelong

private

Definición en la línea 91 del archivo CmdHelp.hpp.

titleshort

std::string Pds::CmdHelp::titleshort

private

Definición en la línea 92 del archivo CmdHelp.hpp.

titledescription

std::string Pds::CmdHelp::titledescription

private

Definición en la línea 93 del archivo CmdHelp.hpp.

titledata

std::string Pds::CmdHelp::titledata

private

Definición en la línea 94 del archivo CmdHelp.hpp.

titledefault

std::string Pds::CmdHelp::titledefault

private

Definición en la línea 95 del archivo CmdHelp.hpp.

textdata

std::string Pds::CmdHelp::textdata

private

Definición en la línea 96 del archivo CmdHelp.hpp.