Dokumentacja klasy Animal

#include <animal.hpp>

Diagram dziedziczenia dla Animal

Lista wszystkich składowych.

Metody publiczne
	Animal (unsigned int ID)
unsigned int	getID () const
unsigned int	getLiderID () const
Vector2D	go (int t)
void	reaction (list< Animal_ > &family, list< Animal_ > &opponent, Obstacles &obs)
void	setBehavior (Behavior *beh)
void	setID (unsigned int ID)
void	setLiderID (unsigned int ID)
Atrybuty chronione
Behavior *	_behavior
unsigned int	_ID
unsigned int	_LiderID
int	_Order
unsigned int	_OrderParam
unsigned int	_Target
Przyjaciele
ostream &	operator<< (ostream &Strm, const Animal &anim)
istream &	operator>> (istream &Strm, Animal &anim)

---

Dokumentacja konstruktora i destruktora

Animal::Animal

(

unsigned int

ID

)

Konstruktor. Ustawia ID (

Zobacz również:

Animal_). Ustawia stan na 'zywy' (

_state). Ustawia _behavior na 0.

Parametry:

ID

- unikalny identyfikator zwierzecia

---

Dokumentacja funkcji składowych

unsigned int Animal::getID

(

)

const

Zwraca ID.

Zwraca:

ID zwierzaka

Zobacz również:

_ID

unsigned int Animal::getLiderID

(

)

const

Pobiera ID Lidera

Zwraca:

ID Lidera

Zobacz również:

_LiderID

Vector2D Animal::go

(

int

t

)

Przesuwa zwierzaka wg biezacych parametrow w zadanym czasie t. Dba, aby nowy stan nie przekroczyl wartosci granicznych.

Zwierze moze sie ruszyc, tylko gdy jego energia jest wieksza od 0. Energia zwierzecia jest pomniejsza wg wzoru: E_k=0.5*m*V^2, gdzie E_k - wartosc, o ktora zostaje pomniejszona energia (w zadanym czasie t) m - masa zwierzecia V - biezaca predkosc zwierzecia

Parametry:

t

- czas przesuniecia [ms]

Zwraca:

Nowe wspolrzedne.

poniewaz E_k jest tutaj bez jednostek, to mozemy sobie pozwolic na potegowanie juz zeskalowanego V

void Animal::reaction	(	list< Animal_ > &	family,
		list< Animal_ > &	opponent,
		Obstacles &	obs
	)

Wykonuje zachowanie (Behavior) i ustala biezace parametry zwierzecia (np. orientacje, predkosc).

Parametry:

	lista	swoich
	lista	obcych
	lista	przeszkod

void Animal::setBehavior

(

Behavior *

beh

)

Ustawia wskaznik zachowania.

Parametry:

zachowanie

void Animal::setID

(

unsigned int

ID

)

Ustala ID

void Animal::setLiderID

(

unsigned int

ID

)

Ustala ID lidera

Parametry:

IDLidera

Zobacz również:

_LiderID

---

Dokumentacja przyjaciół i funkcji związanych

ostream& operator<<	(	ostream &	Strm,
		const Animal &	anim
	)			[friend]

istream& operator>>	(	istream &	Strm,
		Animal &	anim
	)			[friend]

---

Dokumentacja atrybutów składowych

Behavior* Animal::_behavior [protected]

unsigned int Animal::_ID [protected]

unsigned int Animal::_LiderID [protected]

int Animal::_Order [protected]

unsigned int Animal::_OrderParam [protected]

unsigned int Animal::_Target [protected]

---

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

• inc/animal.hpp
• src/animal.cpp

---