Dokumentace souboru tixml.cpp

#include <iostream>
#include <string>
#include <constants.h>
#include "tixml.h"
#include "agar.h"

Graf závislostí na vkládaných souborech pro tixml.cpp:

Funkce
TiXmlElement *	TiXmlRootElement (TiXmlDocument &doc, std::string &filename, const std::string &rootEl_name, bool checkAttr_name)
	Načte dokument a v něm najde RootElement, variabilně kontroluje atribut name.
void	TiXmlSaveDocument (TiXmlDocument &doc, std::string &filename)
	Uloží dokument.
bool	readStringAttr (TiXmlElement *El, const char *name, std::string &outValue)
	Načtení hodnoty atributu do stringu.
TiXmlElement *	subElement (TiXmlElement *Element, const char *subEl_name)
	Nalezení subelementu.
void	attr_Name (TiXmlElement *El, std::string &name)
	Zpracování specifických atributů.
void	attr_HeightWidth (TiXmlElement *El, int &height, int &width)
	Zpracování specifických atributů.
void	attr_XY (TiXmlElement *El, int &x, int &y)
	Zpracování specifických atributů.
void	attr_Count (TiXmlElement *El, int &count)
	Zpracování specifických atributů.
void	attr_SpeedLivesIntelligence (TiXmlElement *El, Uint16 &speed, Uint16 &lives, Uint16 &intelligence)
	Zpracování specifických atributů.

---

Dokumentace funkcí

void attr_Count	(	TiXmlElement *	El,
		int &	count
	)

Zpracování specifických atributů.

Naplní parametry mimo prvního hodnotami adekvátních atributů.

Parametry:

	El	element jehož hodnoty atributů hledáme
	count	hodnota atributu count, povinný

Výjimky:

string

chybová hláška, pokud atribut chybí nebo je špatného typu

Tato funkce volá...

void attr_HeightWidth	(	TiXmlElement *	El,
		int &	height,
		int &	width
	)

Zpracování specifických atributů.

Naplní parametry mimo prvního hodnotami atributů. Pokud nějaký atribut nenajde uloží do parametru -1.

Parametry:

	El	element jehož hodnoty atributů hledáme
	height	hodnota stejnojmenného atributu nebo -1, nepovinný
	width	hodnota stejnojmenného atributu nebo -1, nepovinný

Výjimky:

string

chybové hlášení, pokud je atribut špatného typu nebo nulový

Tato funkce volá...

void attr_Name	(	TiXmlElement *	El,
		std::string &	name
	)

Zpracování specifických atributů.

Naplní parametry mimo prvního hodnotami atributů. Pokud atribut nenajde uloží do parametru empty string.

Parametry:

	El	element jehož hodnoty atributů hledáme
	name	hodnota stejnojmenného atributu nebo prázdný string, nepovinný

Výjimky:

string

chybové hlášení, pokud je atribut prázdný

Tato funkce volá...

void attr_SpeedLivesIntelligence	(	TiXmlElement *	El,
		Uint16 &	speed,
		Uint16 &	lives,
		Uint16 &	intelligence
	)

Zpracování specifických atributů.

Naplní parametry mimo prvního hodnotami adekvátních atributů.

Parametry:

	El	element jehož hodnoty atributů hledáme
	speed	hodnota atributu speed, povinný
	lives	hodnota atributu lives, povinný
	intelligence	hodnota atributu intelligence, povinný

Výjimky:

string

chybová hláška, pokud atribut chybí nebo je špatného typu

Tato funkce volá...

Tuto funkci volají...

void attr_XY	(	TiXmlElement *	El,
		int &	x,
		int &	y
	)

Zpracování specifických atributů.

Naplní parametry mimo prvního hodnotami adekvátních atributů. Kontroluje také zda je parametr přítomen.

Parametry:

	El	element jehož hodnoty atributů hledáme
	x	hodnota atributu x, povinný
	y	hodnota atributu y, povinný

Výjimky:

string

chybové hlášení, pokud je atribut špatného typu nebo chybí

Tato funkce volá...

bool readStringAttr	(	TiXmlElement *	El,
		const char *	name,
		std::string &	outValue
	)

Načtení hodnoty atributu do stringu.

Vyhledá atribut požadovaného jména, uloží jeho hodnotu typu string.

Parametry:

	El	element, v němž se hledá atribut
	name	jméno hledaného atributu
	outValue	reference na string, do kterého se uloží nalezená hodnota

Návratová hodnota:

Vrací false pokud element nebo jeho atribut neexistuje, jinak true.

Tuto funkci volají...

TiXmlElement* subElement	(	TiXmlElement *	Element,
		const char *	subEl_name
	)

Nalezení subelementu.

Najde požadovaný vnořený element. Při chybě vyvolá výjimku typu string s popisem chyby.

Parametry:

	Element	v němž hledáme vnořený element
	subEl_name	název hledaného elementu

Návratová hodnota:

Vrací subelement.

TiXmlElement* TiXmlRootElement	(	TiXmlDocument &	doc,
		std::string &	filename,
		const std::string &	rootEl_name,
		bool	checkAttr_name
	)

Načte dokument a v něm najde RootElement, variabilně kontroluje atribut name.

Otevře xml dokument, zkontroluje správnost root elementu, variabilně zkontroluje správnost atributu name proti filename. Pokud kontrola selže, vyvolá TiXmlError(). Filename obalí cestou a příponou.

Parametry:

	doc	prázdný TiXmlDocument
	filename	jméno souboru pro otevření, zadávejte bez cesty a bez přípony
	rootEl_name	vyžádané jméno root elementu, pokud je prázdné nekontrokluje se
	checkAttr_name	pokud true, provede kontrolu atributu name root elementu

Návratová hodnota:

Vrací root element.

Viz také:

TiXmlError()

Tato funkce volá...

void TiXmlSaveDocument	(	TiXmlDocument &	doc,
		std::string &	filename
	)

Uloží dokument.

Tato funkce volá...

Tuto funkci volají...