moConfigDefinition Class Reference

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

#include <moConfig.h>

Inheritance diagram for moConfigDefinition:

Public Member Functions
	moConfigDefinition ()
	constructor More...
virtual	~moConfigDefinition ()
	destructor More...
	moConfigDefinition (const moConfigDefinition &p_src)
	copy constructor More...
moConfigDefinition &	operator= (const moConfigDefinition &p_src)
	assignment copy operator More...
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. More...
moParamDefinitions *	GetParamDefinitions ()
	Devuelve el puntero al arreglo de definciones de parámetros. More...
moParamIndexes &	ParamIndexes ()
	Devuelve el puntero al arreglo de índices de los parámetros. More...
void	Set (moText p_objectname, moText p_objectclass)
	Fija el nombre y la clase del objeto a configurar. More...
const moText &	GetObjectName ()
	Devuelve el nombre del objeto asociado a este config. More...
const moText &	GetObjectClass ()
	Devuelve el nombre de la clase del objeto asociado a este config. More...
bool	SetParamIndex (int defined_array_index, moParamIndex paramindex)
	Fija el indice del array con el indice del parametro... More...
bool	SetIndex (moText p_name, MOint p_index)
bool	Exists (moText p_name)
	Verifica si el parametro no existe ya. More...
const moParamDefinition &	GetParamDefinition (const moText &p_param_name)
const moText &	ToJSON ()
	Devuelve en formato texto la estructura del objeto convertida a JSON. More...
Public Member Functions inherited from moAbstract
	moAbstract ()
virtual	~moAbstract ()
virtual MOboolean	Init ()
	Inicializa el objeto. More...
virtual MOboolean	Finish ()
	Finaliza el objeto, libera recursos. More...
MOboolean	Initialized ()
	Pregunta si está inicializado. More...

Additional Inherited Members
Public Attributes inherited from moAbstract
MOboolean	m_bInitialized
	Valor de inicialización More...
Static Public Attributes inherited from moAbstract
static moDebug *	MODebug2 = new moDebug()
	Clase de impresión de errores para depuración More...
static moTextHeap *	MODebug = new moTextHeap()
	Lista de textos. More...

Detailed Description

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

See also

moParamDefinition

moMoldeoObject

moConfig

Definition at line 57 of file moConfig.h.

Constructor & Destructor Documentation

moConfigDefinition::moConfigDefinition

(

)

constructor

Definition at line 62 of file moConfig.cpp.

moConfigDefinition::~moConfigDefinition ( )

virtual

destructor

Definition at line 66 of file moConfig.cpp.

moConfigDefinition::moConfigDefinition

(

const moConfigDefinition &

p_src

)

copy constructor

Definition at line 70 of file moConfig.cpp.

Member Function Documentation

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.

Parameters

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

Definition at line 139 of file moConfig.cpp.

bool moConfigDefinition::Exists

(

moText

p_name

)

Verifica si el parametro no existe ya.

Permite verificar si un parametro se encuentra definido

Parameters

p_name

el nombre del parametro

Returns

verdadero si ya existe

Definition at line 89 of file 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.

Returns

el nombre de la clase

Definition at line 125 of file moConfig.h.

const moText& moConfigDefinition::GetObjectName ( )

inline

Devuelve el nombre del objeto asociado a este config.

El nombre del objeto no especifica la clase.

Returns

el nombre del objeto

Definition at line 116 of file moConfig.h.

const moParamDefinition & moConfigDefinition::GetParamDefinition

(

const moText &

p_param_name

)

Definition at line 99 of file 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

Returns

el puntero al arreglo de definiciones de parámetros moParamDefinitions

Definition at line 88 of file moConfig.h.

moConfigDefinition & moConfigDefinition::operator=

(

const moConfigDefinition &

p_src

)

assignment copy operator

Definition at line 76 of file 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

Returns

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

Definition at line 97 of file 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.

Parameters

p_objectname	el nombre del objeto
p_objectclass	la clase del objeto

Definition at line 106 of file moConfig.h.

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

Definition at line 114 of file 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)

Parameters

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

Returns

verdadero si pudo asociarlo correctamente...

Definition at line 223 of file moConfig.cpp.

const moText & moConfigDefinition::ToJSON

(

)

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

Definition at line 252 of file moConfig.cpp.

---

The documentation for this class was generated from the following files:

• libmoldeo/moConfig.h
• libmoldeo/moConfig.cpp