definición de todos los parámetros a encontrar o a crear dentro del moConfig Más...

#include <moConfig.h>

Diagrama de herencias de moConfigDefinition

Métodos públicos
	moConfigDefinition ()
	constructor Más...

virtual	~moConfigDefinition ()
	destructor Más...

	moConfigDefinition (const moConfigDefinition &p_src)
	copy constructor Más...

moConfigDefinition &	operator= (const moConfigDefinition &p_src)
	assignment copy operator Más...

void	Add (const moText &p_name, moParamType p_type, int p_index=-1, const moValue &p_defaultvalue=moValue("INVALID", MO_VALUE_UNDEFINED), const moText &p_OptionsStr=moText(""))
	Agrega la definición de un parámetro con un valor predeterminado a tomar. Más...

moParamDefinitions *	GetParamDefinitions ()
	Devuelve el puntero al arreglo de definciones de parámetros. Más...

moParamIndexes &	ParamIndexes ()
	Devuelve el puntero al arreglo de índices de los parámetros. Más...

void	Set (moText p_objectname, moText p_objectclass)
	Fija el nombre y la clase del objeto a configurar. Más...

const moText &	GetObjectName ()
	Devuelve el nombre del objeto asociado a este config. Más...

const moText &	GetObjectClass ()
	Devuelve el nombre de la clase del objeto asociado a este config. Más...

bool	SetParamIndex (int defined_array_index, moParamIndex paramindex)
	Fija el indice del array con el indice del parametro... Más...

bool	SetIndex (moText p_name, MOint p_index)

bool	Exists (moText p_name)
	Verifica si el parametro no existe ya. Más...

const moParamDefinition &	GetParamDefinition (const moText &p_param_name)

const moText &	ToJSON ()
	Devuelve en formato texto la estructura del objeto convertida a JSON. Más...

Métodos públicos heredados desde moAbstract
	moAbstract ()

virtual	~moAbstract ()

virtual MOboolean	Init ()
	Inicializa el objeto. Más...

virtual MOboolean	Finish ()
	Finaliza el objeto, libera recursos. Más...

MOboolean	Initialized ()
	Pregunta si está inicializado. Más...

Otros miembros heredados
Atributos públicos heredados desde moAbstract
MOboolean	m_bInitialized
	Valor de inicialización. Más...

Atributos públicos estáticos heredados desde moAbstract
static moDebug *	MODebug2 = new moDebug()
	Clase de impresión de errores para depuración. Más...

static moTextHeap *	MODebug = new moTextHeap()
	Lista de textos. Más...

Descripción detallada

definición de todos los parámetros a encontrar o a crear dentro del moConfig

Cumple la función de describir detalladamente que nombres de parámetros y de que tipo deben ser encontrados en el moConfig correspondiente.

Esta clase es rellenada por cada plugin y objeto moldeo que necesite tener controlado el formato de su archivo de configuración

Ver también: moParamDefinition; moMoldeoObject; moConfig

Definición en la línea 57 del archivo moConfig.h.

Documentación del constructor y destructor

moConfigDefinition::moConfigDefinition ( )

constructor

Definición en la línea 62 del archivo moConfig.cpp.

moConfigDefinition::~moConfigDefinition ( )

virtual

destructor

Definición en la línea 66 del archivo moConfig.cpp.

moConfigDefinition::moConfigDefinition ( const moConfigDefinition & p_src )

copy constructor

Definición en la línea 70 del archivo moConfig.cpp.

Documentación de las funciones miembro

void moConfigDefinition::Add	(	const moText &	p_name,
		moParamType	p_type,
		int	p_index = `-1`,
		const moValue &	p_defaultvalue = `moValue("INVALID",MO_VALUE_UNDEFINED)`,
		const moText &	p_OptionsStr = `moText("")`
	)

Agrega la definición de un parámetro con un valor predeterminado a tomar.

Parámetros

p_name	nombre del parámetro
p_type	tipo del parámetro
p_index	índice del parámetro dentro del archivo de configuración (-1 si no está definido aún)
p_defaultvalue	valor predeterminado

Definición en la línea 139 del archivo moConfig.cpp.

bool moConfigDefinition::Exists ( moText p_name )

Verifica si el parametro no existe ya.

Permite verificar si un parametro se encuentra definido

Parámetros

p_name el nombre del parametro

Devuelve: verdadero si ya existe

Definición en la línea 89 del archivo moConfig.cpp.

const moText& moConfigDefinition::GetObjectClass ( )

inline

Devuelve el nombre de la clase del objeto asociado a este config.

El nombre de la clase puede ser del objeto del que deriva este.

Devuelve: el nombre de la clase

Definición en la línea 125 del archivo moConfig.h.

const moText& moConfigDefinition::GetObjectName ( )

inline

Devuelve el nombre del objeto asociado a este config.

El nombre del objeto no especifica la clase.

Devuelve: el nombre del objeto

Definición en la línea 116 del archivo moConfig.h.

const moParamDefinition & moConfigDefinition::GetParamDefinition ( const moText & p_param_name )

Definición en la línea 99 del archivo moConfig.cpp.

moParamDefinitions* moConfigDefinition::GetParamDefinitions ( )

inline

Devuelve el puntero al arreglo de definciones de parámetros.

Este objeto permite la enumeración de las definiciones de cada parámetro

Devuelve: el puntero al arreglo de definiciones de parámetros moParamDefinitions

Definición en la línea 88 del archivo moConfig.h.

moConfigDefinition & moConfigDefinition::operator= ( const moConfigDefinition & p_src )

assignment copy operator

Definición en la línea 76 del archivo moConfig.cpp.

moParamIndexes& moConfigDefinition::ParamIndexes ( )

inline

Devuelve el puntero al arreglo de índices de los parámetros.

Este objeto permite la enumeración de los índices correspondiente a cada parámetro

Devuelve: el puntero al arreglo de índices de los parámetros

Definición en la línea 97 del archivo moConfig.h.

void moConfigDefinition::Set	(	moText	p_objectname,
		moText	p_objectclass
	)

inline

Fija el nombre y la clase del objeto a configurar.

El nombre del objeto no especifica la clase. El nombre de la clase puede ser del objeto del que deriva este.

Parámetros

p_objectname	el nombre del objeto
p_objectclass	la clase del objeto

Definición en la línea 106 del archivo moConfig.h.

bool moConfigDefinition::SetIndex	(	moText	p_name,
		MOint	p_index
	)

Definición en la línea 114 del archivo moConfig.cpp.

bool moConfigDefinition::SetParamIndex	(	int	defined_array_index,
		moParamIndex	paramindex
	)

Fija el indice del array con el indice del parametro...

Asocia en el array m_ParamIndexes, un entero (para el acceso rapido) al indice de un parametro... esta funcion es solo para facilitar el acceso a un parametro, sin necesidad de generar una busqueda a cada vez permitiendo tener configs de muchos parametros con acceso de orden 1. (no N)

Parámetros

defined_array_index	el entero con el que se asocia el parametro
paramindex	es el indice que corresponde a la posicion del parámetro dentro del xml del archivo de configuracion

Devuelve: verdadero si pudo asociarlo correctamente...

Definición en la línea 223 del archivo moConfig.cpp.

const moText & moConfigDefinition::ToJSON ( )

Devuelve en formato texto la estructura del objeto convertida a JSON.

Definición en la línea 252 del archivo moConfig.cpp.

La documentación para esta clase fue generada a partir de los siguientes ficheros:

libmoldeo/moConfig.h
libmoldeo/moConfig.cpp

Métodos públicos

Otros miembros heredados

Descripción detallada

Documentación del constructor y destructor

Documentación de las funciones miembro