Dokumentacja klasy History

#include <history.hpp>

Lista wszystkich składowych.

---

Opis szczegółowy

Klasa przechowujaca historie zwierzat i zdarzen.

Autor:

Arkadiusz Lisiecki

Wersja:

1.0

Data:

2007-11-29

Sloty publiczne
void	saveToMFile (string fname)
Metody publiczne
void	add (unsigned int ID, AnimalParam &param, unsigned int t)
void	addEvent (Event &ev)
AnimalParam	get (unsigned int ID, unsigned int t)
void	getEvent (unsigned int t, list< Event > &ret)
	History ()
Atrybuty chronione
map< unsigned int, History_ >	_animalHist
list< Event >	_eventHist

---

Dokumentacja konstruktora i destruktora

History::History

(

)

Konstruktor.

---

Dokumentacja funkcji składowych

void History::add	(	unsigned int	ID,
		AnimalParam &	param,
		unsigned int	t
	)

Dodaj moment historyczny

Parametry:

	identyfikator	zwierzecia
	parametry	w danym momencie
	moment	[ms]

void History::addEvent

(

Event &

ev

)

Dodaje zdarzenie

Parametry:

zdarzenie

AnimalParam History::get	(	unsigned int	ID,
		unsigned int	t
	)

Pobierz moment historyczny

Parametry:

	indentyfikator	zwierzecia
	moment	[ms]

Zwraca:

zwracane sa parametry bedace najblizej momentu, jesli identyfikator nie istnieje, zwracane sa 'zerowe' parametry

void History::getEvent	(	unsigned int	t,
		list< Event > &	ret
	)

Pobiera zdarzenie

Parametry:

	moment	[ms]
	poprzez	zmienna zwracana jest lista zdarzen, ktore wystapily w danym momencie

void History::saveToMFile

(

string

fname

)

[slot]

Wykonuje zrzut historii w formacie m-file.

Parametry:

fname

iterHist->second.saveToMFile(mfile, (*iterHist).first);

---

Dokumentacja atrybutów składowych

map<unsigned int, History_> History::_animalHist [protected]

list<Event> History::_eventHist [protected]

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• inc/history.hpp
• src/history.cpp

---