Referencia de la Clase moConfig

almacena la configuración de los parámetros de un objeto en un archivo XML Más...

#include <moConfig.h>

Lista de todos los miembros.

Métodos públicos
	moConfig ()
	Constructor.
virtual	~moConfig ()
	Destructor.
void	Set (moText p_objectname, moText p_objectclass)
	Fija el nombre y la clase del objeto a configurar.
moText	GetObjectName ()
	Devuelve el nombre del objeto asociado a este config.
moText	GetObjectClass ()
	Devuelve el nombre de la clase del objeto asociado a este config.
moText	GetName ()
	Devuelve el nombre del archivo de configuración.
moParams &	GetParams ()
	Devuelve el puntero al arreglo de parámetros.
MOboolean	IsConfigLoaded ()
	Indica si ha sido cargado con éxito el archivo de configuración.
int	LoadConfig (moText p_filename)
	Lee la configuracion de un archivo.
MOboolean	CreateDefault (moText p_fullconfigfilename)
	Devuelve true si pudo crear el archivo de configuración junto con su archivo correspondiente.
void	UnloadConfig ()
	Elimina todos los parámetros anteriormente cargados.
int	SaveConfig (moText p_filename=moText(""))
	Guarda la configuracion en un archivo físico.
void	DeleteConfig ()
	Borra la configuracion de parámetros con sus respectivos valores.
moText	GetFullText ()
	Devuelve el contenido completo de la configuración como texto plano.
MOuint	GetValuesCount (int p_paramindex)
	Devuelve la cantidad de valores que contiene el parámetro indexado.
moValue &	GetValue (moText nameparam, int indexvalue=-1)
	Devuelve el valor indicado por el nombre del parámetro y el índice del valor.
moValue &	GetValue (int indexparam, int indexvalue=-1)
	Devuelve el valor indicado por el índice del parámetro y el índice del valor.
MOint	Int (moParamReference p_paramreference)
	Acceso rápido a un valor entero.
MOdouble	Double (moParamReference p_paramreference)
	Acceso rápido a un valor double.
moText	Text (moParamReference p_paramreference)
	Acceso rápido a un valor de texto.
MOdouble	Eval (moParamReference p_paramreference, double x,...)
	Acceso rápido a evaluar la función.
MOdouble	Eval (moParamReference p_paramreference)
moParam &	operator[] (MOint p_paramindex)
	Operador de acceso directo a un parámetro por índice.
moParam &	operator[] (moText p_paramname)
	Operador de acceso directo a un parámetro por nombre.
moParam &	operator[] (moParamIndex p_paramindex)
	Operador de acceso directo a un parámetro por estructura de índice (moParamIndex).
moParam &	operator[] (moParamReference p_paramreference)
	Operador de acceso directo a un parámetro por referencia de parámetro (moParamReference).
moParam &	GetCurrentParam ()
	Devuelve el parámetro actualmente seleccionado.
moParam &	GetParam (MOint p_paramindex=-1)
	Devuelve el parámetro por índice.
moParam &	GetParam (moText p_paramname)
	Devuelve el parámetro por nombre.
moParam &	GetParam (moParamIndex p_paramindex)
	Devuelve el parámetro por estructura de índice (moParamIndex).
moParam &	GetParam (moParamReference p_paramreference)
	Devuelve el parámetro por referencia de parámetro (moParamReference).
int	GetParamsCount ()
	Devuelve la cantidad de parámetros de la configuracíón.
int	GetCurrentValueIndex (MOint p_paramindex)
	Devuelve el índice correspondiente al valor seleccionado del parámetro por índice de parámetro.
int	GetParamIndex (moText p_paramname)
	Devuelve el índice correspondiente al parámetro por nombre.
int	GetCurrentParamIndex ()
	Devuelve el índice del parámetro actualmente seleccionado.
void	SetCurrentParamIndex (int)
	Selecciona el parámetro por el índice.
void	FirstParam ()
	Selecciona el primer parámetro.
void	NextParam ()
	Selecciona el próximo parámetro.
void	PrevParam ()
	Selecciona el parámetro anterior.
void	SetCurrentValueIndex (int p_paramindex, int p_valueindex)
	Posiciona el puntero de selección del valor del parámetro a la posición indicada.
moValue &	GetCurrentValue ()
	Devuelve el valor actual del parámetro actual.
void	FirstValue ()
	Selecciona el primer valor del parámetro actual.
void	NextValue ()
	Selecciona el próximo valor del parámetro actual.
void	PreviousValue ()
	Selecciona el valor anterior del parámetro actual.
moConfigDefinition *	GetConfigDefinition ()
	Devuelve el puntero al objeto de definición de la configuración.
MOint	GetPreConfCount ()
	Devuelve la cantidad de preconfiguraciones definidas.
MOint	GetCurrentPreConf ()
	Devuelve el índice de la preconfiguración seleccionada.
void	SetCurrentPreConf (MOint p_actual)
	Posiciona la preconfiguración actual en el índice indicado.
void	PreConfFirst ()
	Selecciona el primer valor de la preconfiguración.
void	PreConfNext ()
	Selecciona el próximo valor de la preconfiguración.
void	PreConfPrev ()
	Selecciona el valor anterior de la preconfiguración.
void	AddValue (int paramindex, moValue &p_value)
	Agrega un valor.
void	InsertValue (int paramindex, int valueindex, moValue &p_value)
	Inserta un valor.
void	SetValue (int paramindex, int valueindex, moValue &p_value)
	Fija un valor.
void	DeleteValue (int paramindex, int valueindex)
	Borra un valor.
void	AddPreconfig (moPreconfigIndexes &p_preconfindexes)
	Agrega una pre-configuración.
void	InsertPreconfig (int valueindex, moPreconfigIndexes &p_preconfindexes)
	Agrega una pre-configuración.
void	SetPreconfig (int valueindex, moPreconfigIndexes &p_preconfindexes)
	Agrega una pre-configuración.
void	DeletePreconfig (int valueindex)
	Borra una pre-configuración.
Atributos privados
MOboolean	m_ConfigLoaded
moParams	m_Params
moPreConfigs	m_PreConfigs
moConfigDefinition	m_ConfigDefinition
MOint	m_MajorVersion
MOint	m_MinorVersion
moText	m_FileName
int	m_CurrentParam
MOint	m_PreconfParamNum
MOint	m_PreconfActual

---

Descripción detallada

almacena la configuración de los parámetros de un objeto en un archivo XML

Es una clase de manejo de archivo de configuración basado en XML

ex: Config[ PARAM_INDEX ][ VALUE_INDEX ][ SUBVALUE_INDEX ].Float()

Config[ ICON_COLOR ][-1][MO_RED].Float()

---

Documentación del constructor y destructor

moConfig::moConfig (   )

Constructor.

virtual moConfig::~moConfig (   )  [virtual]

Destructor.

---

Documentación de las funciones miembro

void moConfig::AddPreconfig (  moPreconfigIndexes &  p_preconfindexes  )

Agrega una pre-configuración.

void moConfig::AddValue (  int  paramindex, moValue &  p_value )

Agrega un valor.

MOboolean moConfig::CreateDefault (  moText  p_fullconfigfilename  )

Devuelve true si pudo crear el archivo de configuración junto con su archivo correspondiente. Parámetros: @return  true si fue exitoso, false si no lo fue

void moConfig::DeleteConfig (   )

Borra la configuracion de parámetros con sus respectivos valores.

void moConfig::DeletePreconfig (  int  valueindex  )

Borra una pre-configuración.

void moConfig::DeleteValue (  int  paramindex, int  valueindex )

Borra un valor.

MOdouble moConfig::Double (  moParamReference  p_paramreference  )

Acceso rápido a un valor double. Parámetros: indexparam  índice del parámetro Devuelve: el entero

MOdouble moConfig::Eval (  moParamReference  p_paramreference  )

MOdouble moConfig::Eval (  moParamReference  p_paramreference, double  x,   ... )

Acceso rápido a evaluar la función. Parámetros: indexparam  índice del parámetro Devuelve: el entero

void moConfig::FirstParam (   )

Selecciona el primer parámetro.

void moConfig::FirstValue (   )

Selecciona el primer valor del parámetro actual.

moConfigDefinition* moConfig::GetConfigDefinition (   )

Devuelve el puntero al objeto de definición de la configuración. Devuelve: puntero al objeto de definición de la configuración moConfigDefinition

moParam& moConfig::GetCurrentParam (   )

Devuelve el parámetro actualmente seleccionado. Devuelve: referencia al parámetro moParam

int moConfig::GetCurrentParamIndex (   )

Devuelve el índice del parámetro actualmente seleccionado. Devuelve: índice del parámetro

MOint moConfig::GetCurrentPreConf (   )

Devuelve el índice de la preconfiguración seleccionada. Devuelve: índice de la preconfiguración

moValue& moConfig::GetCurrentValue (   )

Devuelve el valor actual del parámetro actual. Devuelve: referencia al valor moValue

int moConfig::GetCurrentValueIndex (  MOint  p_paramindex  )

Devuelve el índice correspondiente al valor seleccionado del parámetro por índice de parámetro. Parámetros: p_paramindex  índice del parámetro Devuelve: índice del valor

moText moConfig::GetFullText (   )

Devuelve el contenido completo de la configuración como texto plano. Devuelve: el texto completo de la configuración

moText moConfig::GetName (   )  [inline]

Devuelve el nombre del archivo de configuración. Devuelve: el nombre del archivo de configuración

moText moConfig::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

moText moConfig::GetObjectName (   )  [inline]

Devuelve el nombre del objeto asociado a este config. El nombre del objeto no especifica la clase. Devuelve: el nombre del objeto

moParam& moConfig::GetParam (  moParamReference  p_paramreference  )  [inline]

Devuelve el parámetro por referencia de parámetro (moParamReference). Parámetros: p_paramreference  estructura de referenciado de parámetro moParamReference Devuelve: referencia al parámetro moParam

moParam& moConfig::GetParam (  moParamIndex  p_paramindex  )  [inline]

Devuelve el parámetro por estructura de índice (moParamIndex). Parámetros: p_paramindex  estructura de índice del parámetro Devuelve: referencia al parámetro moParam

moParam& moConfig::GetParam (  moText  p_paramname  )

Devuelve el parámetro por nombre. Parámetros: p_paramname  nombre del parámetro Devuelve: referencia al parámetro moParam

moParam& moConfig::GetParam (  MOint  p_paramindex = -1  )

Devuelve el parámetro por índice. Parámetros: p_paramindex  estructura de índice del parámetro Devuelve: referencia al parámetro moParam

int moConfig::GetParamIndex (  moText  p_paramname  )

Devuelve el índice correspondiente al parámetro por nombre. Parámetros: p_paramname  nombre del parámetro Devuelve: índice del parámetro

moParams& moConfig::GetParams (   )

Devuelve el puntero al arreglo de parámetros. Devuelve: una referencia al arreglo de parámetros

int moConfig::GetParamsCount (   )

Devuelve la cantidad de parámetros de la configuracíón. Devuelve: cantidad de parámetros

MOint moConfig::GetPreConfCount (   )

Devuelve la cantidad de preconfiguraciones definidas. Devuelve: cantidad de preconfiguraciones

moValue& moConfig::GetValue (  int  indexparam, int  indexvalue = -1 )

Devuelve el valor indicado por el índice del parámetro y el índice del valor. Parámetros: indexparam  índice del parámetro indexvalue  índice del valor dentro del parámetro Devuelve: referencia al valor moValue

moValue& moConfig::GetValue (  moText  nameparam, int  indexvalue = -1 )

Devuelve el valor indicado por el nombre del parámetro y el índice del valor. Parámetros: nameparam  nombre del parámetro indexvalue  índice del valor dentro del parámetro Devuelve: referencia al valor moValue

MOuint moConfig::GetValuesCount (  int  p_paramindex  )

Devuelve la cantidad de valores que contiene el parámetro indexado. Parámetros: p_paramindex  índice del parámetro Devuelve: cantidad de valores

void moConfig::InsertPreconfig (  int  valueindex, moPreconfigIndexes &  p_preconfindexes )

Agrega una pre-configuración.

void moConfig::InsertValue (  int  paramindex, int  valueindex, moValue &  p_value )

Inserta un valor.

MOint moConfig::Int (  moParamReference  p_paramreference  )

Acceso rápido a un valor entero. Parámetros: indexparam  índice del parámetro Devuelve: el entero

MOboolean moConfig::IsConfigLoaded (   )

Indica si ha sido cargado con éxito el archivo de configuración. Devuelve: verdadero si ha sido cargado el archivo, falso si no

int moConfig::LoadConfig (  moText  p_filename  )

Lee la configuracion de un archivo. Devuelve: MO_CONFIG_OK, MO_CONFIGFILE_NOT_FOUND, -1 si es otro error

void moConfig::NextParam (   )

Selecciona el próximo parámetro.

void moConfig::NextValue (   )

Selecciona el próximo valor del parámetro actual.

moParam& moConfig::operator[] (  moParamReference  p_paramreference  )  [inline]

Operador de acceso directo a un parámetro por referencia de parámetro (moParamReference). Parámetros: p_paramreference  estructura de referenciado de parámetro moParamReference Devuelve: referencia al parámetro moParam

moParam& moConfig::operator[] (  moParamIndex  p_paramindex  )  [inline]

Operador de acceso directo a un parámetro por estructura de índice (moParamIndex). Parámetros: p_paramindex  estructura de índice del parámetro Devuelve: referencia al parámetro moParam

moParam& moConfig::operator[] (  moText  p_paramname  )  [inline]

Operador de acceso directo a un parámetro por nombre. Parámetros: p_paramname  nombre del parámetro Devuelve: referencia al parámetro moParam

moParam& moConfig::operator[] (  MOint  p_paramindex  )  [inline]

Operador de acceso directo a un parámetro por índice. Parámetros: p_paramindex  índice del parámetro Devuelve: referencia al parámetro moParam

void moConfig::PreConfFirst (   )

Selecciona el primer valor de la preconfiguración.

void moConfig::PreConfNext (   )

Selecciona el próximo valor de la preconfiguración.

void moConfig::PreConfPrev (   )

Selecciona el valor anterior de la preconfiguración.

void moConfig::PreviousValue (   )

Selecciona el valor anterior del parámetro actual.

void moConfig::PrevParam (   )

Selecciona el parámetro anterior.

int moConfig::SaveConfig (  moText  p_filename = moText("")  )

Guarda la configuracion en un archivo físico. Parámetros: p_filename  nombre completo del archivo incluyendo el camino Devuelve: 0 si fue exitoso, otro valor en otro caso

void moConfig::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

void moConfig::SetCurrentParamIndex (  int   )

Selecciona el parámetro por el índice. Parámetros: índice  del parámetro

void moConfig::SetCurrentPreConf (  MOint  p_actual  )

Posiciona la preconfiguración actual en el índice indicado. Parámetros: índice  de la preconfiguración

void moConfig::SetCurrentValueIndex (  int  p_paramindex, int  p_valueindex )

Posiciona el puntero de selección del valor del parámetro a la posición indicada. Parámetros: p_paramindex  índice de parámetro a posicionar el valor p_valueindex  índice de valor a posicionar

void moConfig::SetPreconfig (  int  valueindex, moPreconfigIndexes &  p_preconfindexes )

Agrega una pre-configuración.

void moConfig::SetValue (  int  paramindex, int  valueindex, moValue &  p_value )

Fija un valor.

moText moConfig::Text (  moParamReference  p_paramreference  )

Acceso rápido a un valor de texto. Parámetros: indexparam  índice del parámetro Devuelve: el entero

void moConfig::UnloadConfig (   )

Elimina todos los parámetros anteriormente cargados. Limpia la configuración.

---

Documentación de los datos miembro

moConfigDefinition moConfig::m_ConfigDefinition [private]

MOboolean moConfig::m_ConfigLoaded [private]

int moConfig::m_CurrentParam [private]

moText moConfig::m_FileName [private]

MOint moConfig::m_MajorVersion [private]

MOint moConfig::m_MinorVersion [private]

moParams moConfig::m_Params [private]

MOint moConfig::m_PreconfActual [private]

moPreConfigs moConfig::m_PreConfigs [private]

MOint moConfig::m_PreconfParamNum [private]

---

La documentación para esta clase fué generada a partir del siguiente archivo:

• D:/_data/proyectos/SINESTESIA/SVNSOURCEFORGE/trunk/0.7/inc/moConfig.h

---