Dokumentacja klasy Animal_

#include <animal_.hpp>

Diagram dziedziczenia dla Animal_

Lista wszystkich składowych.

---

Opis szczegółowy

Klasa definiujaca zwierzaka (bez uwzgledniania strategii).

Autor:

Arkadiusz Lisiecki

Wersja:

1.0

Data:

2007-11-26

Metody publiczne
	Animal_ ()
double	get_a_max () const
double	get_da_max () const
double	get_dE_max () const
double	get_dphi_max () const
double	get_dV_max () const
double	get_E_max () const
double	get_m () const
double	get_phi_max () const
unsigned int	get_r () const
int	get_t () const
double	get_V_max () const
Animal_	getAnimal_ () const
int	getType () const
void	set_a_max (double a_max, double da_max=3)
void	set_da_max (double da_max=3)
void	set_dE_max (double dE_max=3)
void	set_dphi_max (double dphi_max=3)
void	set_dV_max (double dV_max=3)
void	set_E_max (double E_max, double dE_max=3)
void	set_m (double m)
void	set_phi_max (double phi_max, double dphi_max=3)
void	set_r (unsigned int r)
void	set_t (unsigned int t)
void	set_V_max (double V_max, double dV_max=3)
int	setType (int typ)
Atrybuty publiczne
AnimalParam	_param
Atrybuty chronione
double	_a_max
double	_da_max
double	_dE_max
double	_dphi_max
double	_dV_max
double	_E_max
double	_m
string	_name
double	_phi_max
unsigned int	_r
unsigned int	_t
int	_type
double	_V_max

---

Dokumentacja konstruktora i destruktora

Animal_::Animal_

(

)

Konstruktor. Ustawia stan na 'zywy' (

Zobacz również:

AnimalParam).

---

Dokumentacja funkcji składowych

double Animal_::get_a_max

(

)

const

Pobiera przyspieszenie maksymalne.

Zwraca:

przyspieszenie maksymalne

double Animal_::get_da_max

(

)

const

Pobiera tolerancje przyspieszenia.

Zwraca:

tolerancja przyspieszenia

double Animal_::get_dE_max

(

)

const

Pobiera tolerancje energii.

Zwraca:

tolerancja energii

double Animal_::get_dphi_max

(

)

const

Pobiera tolerancje zwrotnosci.

Zwraca:

tolerancja zwrotnosci

double Animal_::get_dV_max

(

)

const

Pobiera tolerancje predkosci.

Zwraca:

tolerancja predkosci

double Animal_::get_E_max

(

)

const

Pobiera energie maksymalna.

Zwraca:

energia maksymalna

double Animal_::get_m

(

)

const

Pobiera mase

Zwraca:

masa [kg]

double Animal_::get_phi_max

(

)

const

Pobiera zwrotnosc maksymalna.

Zwraca:

zwrotnosc maksymalna

unsigned int Animal_::get_r

(

)

const

Pobiera gabaryty zwierzecia

Zwraca:

r - promien [m]

int Animal_::get_t

(

)

const

Pobiera czas reakcji

Zwraca:

t - czas reakcji [ms]

double Animal_::get_V_max

(

)

const

Pobiera predkosc maksymalna.

Zwraca:

predkosc maksymalna zwierzecia

Animal_ Animal_::getAnimal_

(

)

const

Tworzy obiekt Animal_ z biezacymi parametrami

int Animal_::getType

(

)

const

Pobiera typ zwierzecia

void Animal_::set_a_max	(	double	a_max,
		double	da_max = 3
	)

Ustawia przyspieszenie maksymalne i tolerancje.

Parametry:

	a_max	- przyspieszenie maksymalne [m^2/s]
	da_max	- tolerancja [%], domyslnie 3

void Animal_::set_da_max

(

double

da_max = 3

)

Ustala tolerancje przyspieszenia

Parametry:

dV_max

- tolerancja [%], domyslnie 3

void Animal_::set_dE_max

(

double

dE_max = 3

)

Ustala tolerancje energii

Parametry:

dEmax

- tolerancja [%], domyslnie 3

void Animal_::set_dphi_max

(

double

dphi_max = 3

)

Ustala tolerancje zwrotnosci

Parametry:

dphi_max

- tolerancja [%], domyslnie 3

void Animal_::set_dV_max

(

double

dV_max = 3

)

Ustala tolerancje predkosci

Parametry:

dV_max

- tolerancja [%], domyslnie 3

void Animal_::set_E_max	(	double	E_max,
		double	dE_max = 3
	)

Ustawia energie maksymalna i tolerancje.

Parametry:

	E_max	- energia maksymalna
	dE_max	- tolerancja [%], domyslnie 3

void Animal_::set_m

(

double

m

)

Ustala mase.

Parametry:

m

- masa [kg]

void Animal_::set_phi_max	(	double	phi_max,
		double	dphi_max = 3
	)

Ustawia zwrotnosc maksymalna i tolerancje.

Parametry:

	phi_max	- zwrotnosc maksymalna
	dphi_max	- tolerancja [%], domyslnie 3

void Animal_::set_r

(

unsigned int

r

)

Ustala gabaryty zwierzecia zamodelowany jako okrag o promieniu r (

Zobacz również:

_r)

Parametry:

r

- promien [m]

void Animal_::set_t

(

unsigned int

t

)

Ustala czas reakcji

Parametry:

t

- czas reakcji [ms]

void Animal_::set_V_max	(	double	V_max,
		double	dV_max = 3
	)

Ustawia predkosc maksymalna i tolerancje.

Parametry:

	V_max	- predkosc maksymalna [m/s]
	dV_max	- tolerancja [%], domyslnie 3

int Animal_::setType

(

int

typ

)

Ustawia typ zwierzecia.

Parametry:

typ,ANIMAL_TYPE_PREDATOR-drapieznik,ANIMAL_TYPE_ANIMAL-ofiara

inny - ofiara

Zwraca:

przyznany typ

---

Dokumentacja atrybutów składowych

double Animal_::_a_max [protected]

double Animal_::_da_max [protected]

double Animal_::_dE_max [protected]

double Animal_::_dphi_max [protected]

double Animal_::_dV_max [protected]

double Animal_::_E_max [protected]

double Animal_::_m [protected]

string Animal_::_name [protected]

AnimalParam Animal_::_param

double Animal_::_phi_max [protected]

unsigned int Animal_::_r [protected]

unsigned int Animal_::_t [protected]

int Animal_::_type [protected]

double Animal_::_V_max [protected]

---

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

• inc/animal_.hpp
• src/animal_.cpp

---