Referencia de la Clase GDT::XML

Escribir y Leer Archivos XML. Más...

Lista de todos los miembros.

Métodos públicos
_GDT_EXPORT_ void	AbrirParaEscribir (const char *strArchivo)
	Abre un archivo XML para escribir sobre él.
_GDT_EXPORT_ void	AbrirParaLeer (const char *strArchivo)
	Abre un archivo XML para leer de él.
_GDT_EXPORT_ void	Cerrar ()
	Cierra un archivo XML abierto.
_GDT_EXPORT_ const wchar_t *	DatosNodo (void)
	Devuelve los datos del nodo que se ha leído.
_GDT_EXPORT_ bool	ElementoVacio (void)
	Devuelve true si el elemento leído está vacío.
_GDT_EXPORT_ void	EscribirCabeceraXML (void)
	Escribe la cabecera XML en un archivo.
_GDT_EXPORT_ void	EscribirCierreEtiqueta (const wchar_t *nombre)
	Escribe el cierre de una etiqueta XML.
_GDT_EXPORT_ void	EscribirComentario (const wchar_t *comentario)
	Escribe un comentario en el archivo XML.
_GDT_EXPORT_ void	EscribirElemento (const wchar_t *nombre, bool vacio=false, const wchar_t *attr1Nombre=0, const wchar_t *attr1Valor=0, const wchar_t *attr2Nombre=0, const wchar_t *attr2Valor=0, const wchar_t *attr3Nombre=0, const wchar_t *attr3Valor=0, const wchar_t *attr4Nombre=0, const wchar_t *attr4Valor=0, const wchar_t *attr5Nombre=0, const wchar_t *attr5Valor=0)
	Escribe un elemento en el archivo XML.
_GDT_EXPORT_ void	EscribirRupturaLinea (void)
	Escribe un salto de línea.
_GDT_EXPORT_ void	EscribirTexto (const wchar_t *texto)
	Escribe un texto en el archivo XML.
_GDT_EXPORT_ bool	Leyendo ()
	Devuelve true si se está leyendo del archivo.
_GDT_EXPORT_ const wchar_t *	NombreAtributo (int id)
	Devuelve el nombre del atributo que está en la posición indicada.
_GDT_EXPORT_ const wchar_t *	NombreNodo (void)
	Devuelve el nombre del nodo que se ha leído.
_GDT_EXPORT_ int	NumeroAtributos (void)
	Cuando se ha leído un elemento, retorna el número de atributos que tiene este.
_GDT_EXPORT_ EXML_NODE	TipoNodo (void)
	Devuelve el tipo de nodo que se ha leído.
_GDT_EXPORT_ const wchar_t *	ValorAtributo (const wchar_t *atributo)
	Devuelve el valor del atributo nombrado.
_GDT_EXPORT_ const wchar_t *	ValorAtributo (int id)
	Devuelve el valor del atributo indicado.
_GDT_EXPORT_	XML ()
_GDT_EXPORT_	~XML ()
Atributos públicos
bool	bEscribir
IFileSystem *	FileSystem
IXMLReader *	readXML
IXMLWriter *	writeXML

---

Descripción detallada

Escribir y Leer Archivos XML.

Esta Clase nos permite manejar información, guardandola y leyendola en archivos XML. Algunas ideas de porque puede ser útil trabajar con XML puede ser:

• Guardar/Leer la configuración de nestro juego, las opciones que tome el usuario.
• Guardar/Leer el avance en un jugeo, para luego restaurarlo y continuar jugando desde el punto guardado.
• Guardar acá el diálogo de los personajes, descripciones de objetos, etc. Así también es posible traducir nuestro juego a varios idiomas.

El formato del archivo es texto plano, codificado como UTF16, y estructurado como XML. Es decir, de esta manera:

 <?xml version="1.0"?>
 <!--Se admiten Comentarios-->
 <elemento atributo1="Valor1" atributo2="Valor2">Este es un texto que contiene la etiqueta elemento.</elemento>

---

Documentación del constructor y destructor

GDT::XML::XML

(

)

GDT::XML::~XML

(

)

---

Documentación de las funciones miembro

void GDT::XML::AbrirParaEscribir

(

const char *

strArchivo

)

Abre un archivo XML para escribir sobre él.

Ejemplo:

 xml.AbrirParaEscribir("datos.xml");

void GDT::XML::AbrirParaLeer

(

const char *

strArchivo

)

Abre un archivo XML para leer de él.

Parámetros:

strArchivo

es la ruta al archivo Ejemplo: xml.AbrirParaLeer("datos.xml");

void GDT::XML::Cerrar

(

void

)

Cierra un archivo XML abierto.

Ejemplo:

xml.Cerrar();

const wchar_t * GDT::XML::DatosNodo

(

void

)

Devuelve los datos del nodo que se ha leído.

bool GDT::XML::ElementoVacio

(

void

)

Devuelve true si el elemento leído está vacío.

void GDT::XML::EscribirCabeceraXML

(

void

)

Escribe la cabecera XML en un archivo.

Es necesario escribir la cabecera primero para que el archivo sea XML válido.

Ejemplo:

 xml.EscribirCabeceraXML();

void GDT::XML::EscribirCierreEtiqueta

(

const wchar_t *

nombre

)

Escribe el cierre de una etiqueta XML.

El estilo de la etiqueta de cierre es así:

 </nombre> 

Ejemplo:

xml.EscribirCierreCabecera(L"nombre");

void GDT::XML::EscribirComentario

(

const wchar_t *

comentario

)

Escribe un comentario en el archivo XML.

Ejemplo:

xml.EscribirComentario(L"Esto es un comentario");

void GDT::XML::EscribirElemento	(	const wchar_t *	nombre,
		bool	vacio = false,
		const wchar_t *	attr1Nombre = 0,
		const wchar_t *	attr1Valor = 0,
		const wchar_t *	attr2Nombre = 0,
		const wchar_t *	attr2Valor = 0,
		const wchar_t *	attr3Nombre = 0,
		const wchar_t *	attr3Valor = 0,
		const wchar_t *	attr4Nombre = 0,
		const wchar_t *	attr4Valor = 0,
		const wchar_t *	attr5Nombre = 0,
		const wchar_t *	attr5Valor = 0
	)

Escribe un elemento en el archivo XML.

Se pueden indicar hasta 5 atributos.

Los elementos son de la siguiente forma:

 <nombre atributo1=valor1 atributo2=valor2> 

Ejemplo:

xml.EscribirElemento(L"persona", false, L"nombre", L"GDT", L"edad" , L"5");

void GDT::XML::EscribirRupturaLinea

(

void

)

Escribe un salto de línea.

Ejemplo:

xml.EscribirRupturaLinea();

void GDT::XML::EscribirTexto

(

const wchar_t *

texto

)

Escribe un texto en el archivo XML.

El texto se escribe de la siguiente forma:

<elemento>Texto</elemento>

xml.EscribirTexto(L"Hola XML");

bool GDT::XML::Leyendo

(

)

Devuelve true si se está leyendo del archivo.

Ejemplo:

while (xml.Leyendo() )
{
}

const wchar_t * GDT::XML::NombreAtributo

(

int

id

)

Devuelve el nombre del atributo que está en la posición indicada.

const wchar_t * GDT::XML::NombreNodo

(

void

)

Devuelve el nombre del nodo que se ha leído.

int GDT::XML::NumeroAtributos

(

void

)

Cuando se ha leído un elemento, retorna el número de atributos que tiene este.

Ejemplo:

int atributos = xml.NumeroAtributos();

EXML_NODE GDT::XML::TipoNodo

(

void

)

Devuelve el tipo de nodo que se ha leído.

Las constantes de cada tipo de nodo son:

• XML_LEIDO_NADA
• XML_LEIDO_ELEMENTO
• XML_LEIDO_FINELEMENTO
• XML_LEIDO_TEXTO
• XML_LEIDO_COMENTARIO

Ejemplo:

switch ( xml.TipoNodo() )
{
    case XML_LEIDO_ELEMENTO:
    break;
}

const wchar_t * GDT::XML::ValorAtributo

(

const wchar_t *

atributo

)

Devuelve el valor del atributo nombrado.

const wchar_t * GDT::XML::ValorAtributo

(

int

id

)

Devuelve el valor del atributo indicado.

---

Documentación de los datos miembro

bool GDT::XML::bEscribir

IFileSystem* GDT::XML::FileSystem

IXMLReader* GDT::XML::readXML

IXMLWriter* GDT::XML::writeXML

---